{"items":[{"type":"link","label":"Solidgate • API reference","link":"/api","routeSlug":"/api","content":{"contentType":"overview","meta":{"name":"Solidgate • API reference"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Terms and policies","url":"https://solidgate.com/legal/terms-of-use/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Solidgate • API reference (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Solidgate API is a payment gateway API that enables merchants to securely process and manage transactions, including card payments and alternative payment methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OpenAPI specification"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Full schema for programmatic integration: endpoint paths, request/response shapes, and field definitions."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","flexWrap":"wrap","gap":"8px","marginBottom":"24px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/_bundle/api/@v1/index.yaml?download","className":"sg-lang-btn","style":{"display":"inline-flex","alignItems":"center","gap":"5px","background":"#000","color":"#fff","padding":"6px 14px","borderRadius":"6px","textDecoration":"none","fontSize":"13px","fontFamily":"'Inter',sans-serif","width":"96px !important","maxWidth":"96px !important","flex":"0 0 96px !important","justifyContent":"flex-start","transition":"opacity 0.2s ease"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"svg","attrs":{"width":"14","height":"14","viewbox":"0 0 24 24","fill":"#fff","style":{"width":"14px !important","height":"14px !important","maxWidth":"14px !important","maxHeight":"14px !important","flexShrink":"0","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"path","attrs":{"d":"m0 .97 4.111 6.453v4.09h2.638v-4.09L11.053.969H8.214L5.58 5.125 2.965.969Zm12.093.024-4.47 10.544h2.114l.97-2.345h4.775l.804 2.345h2.26L14.255.994Zm1.133 2.225 1.463 3.87h-3.096zm3.06 9.475v10.29H24v-2.199h-5.454v-8.091zm-12.175.002v10.335h2.217v-7.129l2.32 4.792h1.746l2.4-4.96v7.295h2.127V12.696h-2.904L9.44 17.37l-2.455-4.674Z"}},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    YAML\n  "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/_bundle/api/@v1/index.json?download","className":"sg-lang-btn","style":{"display":"inline-flex","alignItems":"center","gap":"5px","background":"#000","color":"#fff","padding":"6px 14px","borderRadius":"6px","textDecoration":"none","fontSize":"13px","fontFamily":"'Inter',sans-serif","width":"96px !important","maxWidth":"96px !important","flex":"0 0 96px !important","justifyContent":"flex-start","transition":"opacity 0.2s ease"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"svg","attrs":{"width":"14","height":"14","viewbox":"0 0 24 24","fill":"#fff","style":{"width":"14px !important","height":"14px !important","maxWidth":"14px !important","maxHeight":"14px !important","flexShrink":"0","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"path","attrs":{"d":"M12.043 23.968c.479-.004.953-.029 1.426-.094a11.805 11.805 0 003.146-.863 12.404 12.404 0 003.793-2.542 11.977 11.977 0 002.44-3.427 11.794 11.794 0 001.02-3.476c.149-1.16.135-2.346-.045-3.499a11.96 11.96 0 00-.793-2.788 11.197 11.197 0 00-.854-1.617c-1.168-1.837-2.861-3.314-4.81-4.3a12.835 12.835 0 00-2.172-.87h-.005c.119.063.24.132.345.201.12.074.239.146.351.225a8.93 8.93 0 011.559 1.33c1.063 1.145 1.797 2.548 2.218 4.041.284.982.434 1.998.495 3.017.044.743.044 1.491-.047 2.229-.149 1.27-.554 2.51-1.228 3.596a7.475 7.475 0 01-1.903 2.084c-1.244.928-2.877 1.482-4.436 1.114a3.916 3.916 0 01-.748-.258 4.692 4.692 0 01-.779-.45 6.08 6.08 0 01-1.244-1.105 6.507 6.507 0 01-1.049-1.747 7.366 7.366 0 01-.494-2.54c-.03-1.273.225-2.553.854-3.67a6.43 6.43 0 011.663-1.918c.225-.178.464-.333.704-.479l.016-.007a5.121 5.121 0 00-1.441-.12 4.963 4.963 0 00-1.228.24c-.359.12-.704.27-1.019.45a6.146 6.146 0 00-.733.494c-.211.18-.42.36-.615.555-1.123 1.153-1.768 2.682-2.022 4.256-.15.973-.15 1.96-.091 2.95.105 1.395.391 2.787.945 4.062a8.518 8.518 0 001.348 2.173 8.14 8.14 0 003.132 2.23 7.934 7.934 0 002.113.54c.074.015.149.015.209.015zm-2.934-.398a4.102 4.102 0 01-.45-.228 8.5 8.5 0 01-2.038-1.534c-1.094-1.137-1.827-2.566-2.247-4.08a15.184 15.184 0 01-.495-3.172 12.14 12.14 0 01.046-2.082c.135-1.257.495-2.501 1.124-3.58a6.889 6.889 0 011.783-2.053 6.23 6.23 0 011.633-.9 5.363 5.363 0 013.522-.045c.029 0 .029 0 .045.03.015.015.045.015.06.03.045.016.104.045.165.074.239.12.479.271.704.42a6.294 6.294 0 012.097 2.502c.42.914.615 1.934.631 2.938.014 1.079-.18 2.157-.645 3.146a6.42 6.42 0 01-2.638 2.832c.09.03.18.045.271.075.225.044.449.074.688.074 1.468.045 2.892-.66 3.94-1.647.195-.18.375-.375.54-.585.225-.27.435-.54.614-.823.239-.375.435-.75.614-1.154a8.112 8.112 0 00.509-1.664c.196-1.004.211-2.022.149-3.026-.135-2.022-.673-4.045-1.842-5.724a9.054 9.054 0 00-.555-.719 9.868 9.868 0 00-1.063-1.034 8.477 8.477 0 00-1.363-.915 9.927 9.927 0 00-1.692-.598l-.3-.06c-.209-.03-.42-.044-.634-.06a8.453 8.453 0 00-1.015.016c-.704.045-1.412.16-2.112.337C5.799 1.227 2.863 3.566 1.3 6.67A11.834 11.834 0 00.238 9.801a11.81 11.81 0 00-.104 3.775c.12 1.02.374 2.023.778 2.977.227.57.511 1.124.825 1.648 1.094 1.783 2.683 3.236 4.51 4.24.688.39 1.408.69 2.157.944.226.074.45.15.689.21z"}},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    JSON\n  "},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Get started quickly"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Solidgate offers APIs for processing and managing payments via HTTP/REST or Solidgate libraries, with JSON as the data exchange format."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","flexWrap":"wrap","gap":"8px","marginBottom":"24px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.postman.com/solidgate/solidgate-api/overview","target":"_blank","rel":"noopener noreferrer","className":"sg-lang-btn","style":{"display":"inline-flex","alignItems":"center","gap":"5px","background":"#000","color":"#fff","padding":"6px 14px","borderRadius":"6px","textDecoration":"none","fontSize":"13px","fontFamily":"'Inter',sans-serif","width":"96px !important","maxWidth":"96px !important","flex":"0 0 96px !important","justifyContent":"flex-start","transition":"opacity 0.2s ease"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"svg","attrs":{"width":"18","height":"18","viewbox":"0 0 24 24","fill":"none","style":{"width":"18px !important","height":"18px !important","maxWidth":"18px !important","maxHeight":"18px !important","flexShrink":"0","display":"inline-block"},"aria-hidden":"true"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"path","attrs":{"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"}},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    Postman\n  "},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Frontend SDK"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"These are the primary frontend libraries. Use them to embed payment forms directly in your client-side application."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","flexWrap":"wrap","gap":"8px","marginBottom":"24px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://github.com/solidgate-tech/react-sdk","target":"_blank","rel":"noopener noreferrer","id":"reactsdk","className":"sg-lang-btn","style":{"display":"inline-flex","alignItems":"center","gap":"5px","background":"#000","color":"#fff","padding":"6px 14px","borderRadius":"6px","textDecoration":"none","fontSize":"13px","fontFamily":"'Inter',sans-serif","width":"96px !important","maxWidth":"96px !important","flex":"0 0 96px !important","justifyContent":"flex-start","transition":"opacity 0.2s ease"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"svg","attrs":{"width":"14","height":"14","viewbox":"0 0 24 24","fill":"#fff","style":{"width":"14px !important","height":"14px !important","maxWidth":"14px !important","maxHeight":"14px !important","flexShrink":"0","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"path","attrs":{"d":"M14.23 12.004a2.236 2.236 0 0 1-2.235 2.236 2.236 2.236 0 0 1-2.236-2.236 2.236 2.236 0 0 1 2.235-2.236 2.236 2.236 0 0 1 2.236 2.236zm2.648-10.69c-1.346 0-3.107.96-4.888 2.622-1.78-1.653-3.542-2.602-4.887-2.602-.41 0-.783.093-1.106.278-1.375.793-1.683 3.264-.973 6.365C1.98 8.917 0 10.42 0 12.004c0 1.59 1.99 3.097 5.043 4.03-.704 3.113-.39 5.588.988 6.38.32.187.69.275 1.102.275 1.345 0 3.107-.96 4.888-2.624 1.78 1.654 3.542 2.603 4.887 2.603.41 0 .783-.09 1.106-.275 1.374-.792 1.683-3.263.973-6.365C22.02 15.096 24 13.59 24 12.004c0-1.59-1.99-3.097-5.043-4.032.704-3.11.39-5.587-.988-6.38-.318-.184-.688-.277-1.092-.278zm-.005 1.09v.006c.225 0 .406.044.558.127.666.382.955 1.835.73 3.704-.054.46-.142.945-.25 1.44-.96-.236-2.006-.417-3.107-.534-.66-.905-1.345-1.727-2.035-2.447 1.592-1.48 3.087-2.292 4.105-2.295zm-9.77.02c1.012 0 2.514.808 4.11 2.28-.686.72-1.37 1.537-2.02 2.442-1.107.117-2.154.298-3.113.538-.112-.49-.195-.964-.254-1.42-.23-1.868.054-3.32.714-3.707.19-.09.4-.127.563-.132zm4.882 3.05c.455.468.91.992 1.36 1.564-.44-.02-.89-.034-1.345-.034-.46 0-.915.01-1.36.034.44-.572.895-1.096 1.345-1.565zM12 8.1c.74 0 1.477.034 2.202.093.406.582.802 1.203 1.183 1.86.372.64.71 1.29 1.018 1.946-.308.655-.646 1.31-1.013 1.95-.38.66-.773 1.288-1.18 1.87-.728.063-1.466.098-2.21.098-.74 0-1.477-.035-2.202-.093-.406-.582-.802-1.204-1.183-1.86-.372-.64-.71-1.29-1.018-1.946.303-.657.646-1.313 1.013-1.954.38-.66.773-1.286 1.18-1.868.728-.064 1.466-.098 2.21-.098zm-3.635.254c-.24.377-.48.763-.704 1.16-.225.39-.435.782-.635 1.174-.265-.656-.49-1.31-.676-1.947.64-.15 1.315-.283 2.015-.386zm7.26 0c.695.103 1.365.23 2.006.387-.18.632-.405 1.282-.66 1.933-.2-.39-.41-.783-.64-1.174-.225-.392-.465-.774-.705-1.146zm3.063.675c.484.15.944.317 1.375.498 1.732.74 2.852 1.708 2.852 2.476-.005.768-1.125 1.74-2.857 2.475-.42.18-.88.342-1.355.493-.28-.958-.646-1.956-1.1-2.98.45-1.017.81-2.01 1.085-2.964zm-13.395.004c.278.96.645 1.957 1.1 2.98-.45 1.017-.812 2.01-1.086 2.964-.484-.15-.944-.318-1.37-.5-1.732-.737-2.852-1.706-2.852-2.474 0-.768 1.12-1.742 2.852-2.476.42-.18.88-.342 1.356-.494zm11.678 4.28c.265.657.49 1.312.676 1.948-.64.157-1.316.29-2.016.39.24-.375.48-.762.705-1.158.225-.39.435-.788.636-1.18zm-9.945.02c.2.392.41.783.64 1.175.23.39.465.772.705 1.143-.695-.102-1.365-.23-2.006-.386.18-.63.406-1.282.66-1.933zM17.92 16.32c.112.493.2.968.254 1.423.23 1.868-.054 3.32-.714 3.708-.147.09-.338.128-.563.128-1.012 0-2.514-.807-4.11-2.28.686-.72 1.37-1.536 2.02-2.44 1.107-.118 2.154-.3 3.113-.54zm-11.83.01c.96.234 2.006.415 3.107.532.66.905 1.345 1.727 2.035 2.446-1.595 1.483-3.092 2.295-4.11 2.295-.22-.005-.406-.05-.553-.132-.666-.38-.955-1.834-.73-3.703.054-.46.142-.944.25-1.438zm4.56.64c.44.02.89.034 1.345.034.46 0 .915-.01 1.36-.034-.44.572-.895 1.095-1.345 1.565-.455-.47-.91-.993-1.36-1.565z"}},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    React\n  "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://github.com/solidgate-tech/vue-sdk","target":"_blank","rel":"noopener noreferrer","id":"vuesdk","className":"sg-lang-btn","style":{"display":"inline-flex","alignItems":"center","gap":"5px","background":"#000","color":"#fff","padding":"6px 14px","borderRadius":"6px","textDecoration":"none","fontSize":"13px","fontFamily":"'Inter',sans-serif","width":"96px !important","maxWidth":"96px !important","flex":"0 0 96px !important","justifyContent":"flex-start","transition":"opacity 0.2s ease"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"svg","attrs":{"width":"14","height":"14","viewbox":"0 0 24 24","fill":"#fff","style":{"width":"14px !important","height":"14px !important","maxWidth":"14px !important","maxHeight":"14px !important","flexShrink":"0","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"path","attrs":{"d":"M24,1.61H14.06L12,5.16,9.94,1.61H0L12,22.39ZM12,14.08,5.16,2.23H9.59L12,6.41l2.41-4.18h4.43Z"}},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    Vue\n  "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://github.com/solidgate-tech/angular-sdk","target":"_blank","rel":"noopener noreferrer","id":"angularsdk","className":"sg-lang-btn","style":{"display":"inline-flex","alignItems":"center","gap":"5px","background":"#000","color":"#fff","padding":"6px 14px","borderRadius":"6px","textDecoration":"none","fontSize":"13px","fontFamily":"'Inter',sans-serif","width":"96px !important","maxWidth":"96px !important","flex":"0 0 96px !important","justifyContent":"flex-start","transition":"opacity 0.2s ease"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"svg","attrs":{"width":"14","height":"14","viewbox":"0 0 24 24","fill":"#fff","style":{"width":"14px !important","height":"14px !important","maxWidth":"14px !important","maxHeight":"14px !important","flexShrink":"0","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"path","attrs":{"d":"M16.712 17.711H7.288l-1.204 2.916L12 24l5.916-3.373-1.204-2.916ZM14.692 0l7.832 16.855.814-12.856L14.692 0ZM9.308 0 .662 3.999l.814 12.856L9.308 0Zm-.405 13.93h6.198L12 6.396 8.903 13.93Z"}},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    Angular\n  "},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Backend SDK"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Multiple backend libraries to manage server-side processing, advanced integrations, form resign flows, and reconciling orders."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","flexWrap":"wrap","gap":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://github.com/solidgate-tech/nodejs-sdk","target":"_blank","rel":"noopener noreferrer","id":"nodesdk","className":"sg-lang-btn","style":{"display":"inline-flex","alignItems":"center","gap":"5px","background":"#000","color":"#fff","padding":"6px 14px","borderRadius":"6px","textDecoration":"none","fontSize":"13px","fontFamily":"'Inter',sans-serif","width":"96px !important","maxWidth":"96px !important","flex":"0 0 96px !important","justifyContent":"flex-start","transition":"opacity 0.2s ease"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"svg","attrs":{"width":"14","height":"14","viewbox":"0 0 24 24","fill":"#fff","style":{"width":"14px !important","height":"14px !important","maxWidth":"14px !important","maxHeight":"14px !important","flexShrink":"0","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"path","attrs":{"d":"M11.998,24c-0.321,0-0.641-0.084-0.922-0.247l-2.936-1.737c-0.438-0.245-0.224-0.332-0.08-0.383 c0.585-0.203,0.703-0.25,1.328-0.604c0.065-0.037,0.151-0.023,0.218,0.017l2.256,1.339c0.082,0.045,0.197,0.045,0.272,0l8.795-5.076 c0.082-0.047,0.134-0.141,0.134-0.238V6.921c0-0.099-0.053-0.192-0.137-0.242l-8.791-5.072c-0.081-0.047-0.189-0.047-0.271,0 L3.075,6.68C2.99,6.729,2.936,6.825,2.936,6.921v10.15c0,0.097,0.054,0.189,0.139,0.235l2.409,1.392 c1.307,0.654,2.108-0.116,2.108-0.89V7.787c0-0.142,0.114-0.253,0.256-0.253h1.115c0.139,0,0.255,0.112,0.255,0.253v10.021 c0,1.745-0.95,2.745-2.604,2.745c-0.508,0-0.909,0-2.026-0.551L2.28,18.675c-0.57-0.329-0.922-0.945-0.922-1.604V6.921 c0-0.659,0.353-1.275,0.922-1.603l8.795-5.082c0.557-0.315,1.296-0.315,1.848,0l8.794,5.082c0.57,0.329,0.924,0.944,0.924,1.603 v10.15c0,0.659-0.354,1.273-0.924,1.604l-8.794,5.078C12.643,23.916,12.324,24,11.998,24z M19.099,13.993 c0-1.9-1.284-2.406-3.987-2.763c-2.731-0.361-3.009-0.548-3.009-1.187c0-0.528,0.235-1.233,2.258-1.233 c1.807,0,2.473,0.389,2.747,1.607c0.024,0.115,0.129,0.199,0.247,0.199h1.141c0.071,0,0.138-0.031,0.186-0.081 c0.048-0.054,0.074-0.123,0.067-0.196c-0.177-2.098-1.571-3.076-4.388-3.076c-2.508,0-4.004,1.058-4.004,2.833 c0,1.925,1.488,2.457,3.895,2.695c2.88,0.282,3.103,0.703,3.103,1.269c0,0.983-0.789,1.402-2.642,1.402 c-2.327,0-2.839-0.584-3.011-1.742c-0.02-0.124-0.126-0.215-0.253-0.215h-1.137c-0.141,0-0.254,0.112-0.254,0.253 c0,1.482,0.806,3.248,4.655,3.248C17.501,17.007,19.099,15.91,19.099,13.993z"}},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    Node.js\n  "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://github.com/solidgate-tech/php-sdk","target":"_blank","rel":"noopener noreferrer","id":"phpsdk","className":"sg-lang-btn","style":{"display":"inline-flex","alignItems":"center","gap":"5px","background":"#000","color":"#fff","padding":"6px 14px","borderRadius":"6px","textDecoration":"none","fontSize":"13px","fontFamily":"'Inter',sans-serif","width":"96px !important","maxWidth":"96px !important","flex":"0 0 96px !important","justifyContent":"flex-start","transition":"opacity 0.2s ease"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"svg","attrs":{"width":"14","height":"14","viewbox":"0 0 24 24","fill":"#fff","style":{"width":"14px !important","height":"14px !important","maxWidth":"14px !important","maxHeight":"14px !important","flexShrink":"0","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"path","attrs":{"d":"M7.01 10.207h-.944l-.515 2.648h.838c.556 0 .97-.105 1.242-.314.272-.21.455-.559.55-1.049.092-.47.05-.802-.124-.995-.175-.193-.523-.29-1.047-.29zM12 5.688C5.373 5.688 0 8.514 0 12s5.373 6.313 12 6.313S24 15.486 24 12c0-3.486-5.373-6.312-12-6.312zm-3.26 7.451c-.261.25-.575.438-.917.551-.336.108-.765.164-1.285.164H5.357l-.327 1.681H3.652l1.23-6.326h2.65c.797 0 1.378.209 1.744.628.366.418.476 1.002.33 1.752a2.836 2.836 0 0 1-.305.847c-.143.255-.33.49-.561.703zm4.024.715l.543-2.799c.063-.318.039-.536-.068-.651-.107-.116-.336-.174-.687-.174H11.46l-.704 3.625H9.388l1.23-6.327h1.367l-.327 1.682h1.218c.767 0 1.295.134 1.586.401s.378.7.263 1.299l-.572 2.944h-1.389zm7.597-2.265a2.782 2.782 0 0 1-.305.847c-.143.255-.33.49-.561.703a2.44 2.44 0 0 1-.917.551c-.336.108-.765.164-1.286.164h-1.18l-.327 1.682h-1.378l1.23-6.326h2.649c.797 0 1.378.209 1.744.628.366.417.477 1.001.331 1.751zM17.766 10.207h-.943l-.516 2.648h.838c.557 0 .971-.105 1.242-.314.272-.21.455-.559.551-1.049.092-.47.049-.802-.125-.995s-.524-.29-1.047-.29z"}},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    PHP\n  "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://github.com/solidgate-tech/go-sdk","target":"_blank","rel":"noopener noreferrer","id":"gosdk","className":"sg-lang-btn","style":{"display":"inline-flex","alignItems":"center","gap":"5px","background":"#000","color":"#fff","padding":"6px 14px","borderRadius":"6px","textDecoration":"none","fontSize":"13px","fontFamily":"'Inter',sans-serif","width":"96px !important","maxWidth":"96px !important","flex":"0 0 96px !important","justifyContent":"flex-start","transition":"opacity 0.2s ease"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"svg","attrs":{"width":"14","height":"14","viewbox":"0 0 24 24","fill":"#fff","style":{"width":"14px !important","height":"14px !important","maxWidth":"14px !important","maxHeight":"14px !important","flexShrink":"0","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"path","attrs":{"d":"M1.811 10.231c-.047 0-.058-.023-.035-.059l.246-.315c.023-.035.081-.058.128-.058h4.172c.046 0 .058.035.035.07l-.199.303c-.023.036-.082.07-.117.07zM.047 11.306c-.047 0-.059-.023-.035-.058l.245-.316c.023-.035.082-.058.129-.058h5.328c.047 0 .07.035.058.07l-.093.28c-.012.047-.058.07-.105.07zm2.828 1.075c-.047 0-.059-.035-.035-.07l.163-.292c.023-.035.07-.07.117-.07h2.337c.047 0 .07.035.07.082l-.023.28c0 .047-.047.082-.082.082zm12.129-2.36c-.736.187-1.239.327-1.963.514-.176.046-.187.058-.34-.117-.174-.199-.303-.327-.548-.444-.737-.362-1.45-.257-2.115.175-.795.514-1.204 1.274-1.192 2.22.011.935.654 1.706 1.577 1.835.795.105 1.46-.175 1.987-.77.105-.13.198-.27.315-.434H10.47c-.245 0-.304-.152-.222-.35.152-.362.432-.97.596-1.274a.315.315 0 01.292-.187h4.253c-.023.316-.023.631-.07.947a4.983 4.983 0 01-.958 2.29c-.841 1.11-1.94 1.8-3.33 1.986-1.145.152-2.209-.07-3.143-.77-.865-.655-1.356-1.52-1.484-2.595-.152-1.274.222-2.419.993-3.424.83-1.086 1.928-1.776 3.272-2.02 1.098-.2 2.15-.07 3.096.571.62.41 1.063.97 1.356 1.648.07.105.023.164-.117.2m3.868 6.461c-1.064-.024-2.034-.328-2.852-1.029a3.665 3.665 0 01-1.262-2.255c-.21-1.32.152-2.489.947-3.529.853-1.122 1.881-1.706 3.272-1.95 1.192-.21 2.314-.095 3.33.595.923.63 1.496 1.484 1.648 2.605.198 1.578-.257 2.863-1.344 3.962-.771.783-1.718 1.273-2.805 1.495-.315.06-.63.07-.934.106zm2.78-4.72c-.011-.153-.011-.27-.034-.387-.21-1.157-1.274-1.81-2.384-1.554-1.087.245-1.788.935-2.045 2.033-.21.912.234 1.835 1.075 2.21.643.28 1.285.244 1.905-.07.923-.48 1.425-1.228 1.484-2.233z"}},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    Go\n  "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://github.com/solidgate-tech/kotlin-sdk","target":"_blank","rel":"noopener noreferrer","id":"kotlinsdk","className":"sg-lang-btn","style":{"display":"inline-flex","alignItems":"center","gap":"5px","background":"#000","color":"#fff","padding":"6px 14px","borderRadius":"6px","textDecoration":"none","fontSize":"13px","fontFamily":"'Inter',sans-serif","width":"96px !important","maxWidth":"96px !important","flex":"0 0 96px !important","justifyContent":"flex-start","transition":"opacity 0.2s ease"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"svg","attrs":{"width":"14","height":"14","viewbox":"0 0 24 24","fill":"#fff","style":{"width":"14px !important","height":"14px !important","maxWidth":"14px !important","maxHeight":"14px !important","flexShrink":"0","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"path","attrs":{"d":"M24 24H0V0h24L12 12Z"}},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    Kotlin\n  "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://github.com/solidgate-tech/python-sdk","target":"_blank","rel":"noopener noreferrer","id":"pythonsdk","className":"sg-lang-btn","style":{"display":"inline-flex","alignItems":"center","gap":"5px","background":"#000","color":"#fff","padding":"6px 14px","borderRadius":"6px","textDecoration":"none","fontSize":"13px","fontFamily":"'Inter',sans-serif","width":"96px !important","maxWidth":"96px !important","flex":"0 0 96px !important","justifyContent":"flex-start","transition":"opacity 0.2s ease"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"svg","attrs":{"width":"14","height":"14","viewbox":"0 0 24 24","fill":"#fff","style":{"width":"14px !important","height":"14px !important","maxWidth":"14px !important","maxHeight":"14px !important","flexShrink":"0","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"path","attrs":{"d":"M14.25.18l.9.2.73.26.59.3.45.32.34.34.25.34.16.33.1.3.04.26.02.2-.01.13V8.5l-.05.63-.13.55-.21.46-.26.38-.3.31-.33.25-.35.19-.35.14-.33.1-.3.07-.26.04-.21.02H8.77l-.69.05-.59.14-.5.22-.41.27-.33.32-.27.35-.2.36-.15.37-.1.35-.07.32-.04.27-.02.21v3.06H3.17l-.21-.03-.28-.07-.32-.12-.35-.18-.36-.26-.36-.36-.35-.46-.32-.59-.28-.73-.21-.88-.14-1.05-.05-1.23.06-1.22.16-1.04.24-.87.32-.71.36-.57.4-.44.42-.33.42-.24.4-.16.36-.1.32-.05.24-.01h.16l.06.01h8.16v-.83H6.18l-.01-2.75-.02-.37.05-.34.11-.31.17-.28.25-.26.31-.23.38-.2.44-.18.51-.15.58-.12.64-.1.71-.06.77-.04.84-.02 1.27.05zm-6.3 1.98l-.23.33-.08.41.08.41.23.34.33.22.41.09.41-.09.33-.22.23-.34.08-.41-.08-.41-.23-.33-.33-.22-.41-.09-.41.09zm13.09 3.95l.28.06.32.12.35.18.36.27.36.35.35.47.32.59.28.73.21.88.14 1.04.05 1.23-.06 1.23-.16 1.04-.24.86-.32.71-.36.57-.4.45-.42.33-.42.24-.4.16-.36.09-.32.05-.24.02-.16-.01h-8.22v.82h5.84l.01 2.76.02.36-.05.34-.11.31-.17.29-.25.25-.31.24-.38.2-.44.17-.51.15-.58.13-.64.09-.71.07-.77.04-.84.01-1.27-.04-1.07-.14-.9-.2-.73-.25-.59-.3-.45-.33-.34-.34-.25-.34-.16-.33-.1-.3-.04-.25-.02-.2.01-.13v-5.34l.05-.64.13-.54.21-.46.26-.38.3-.32.33-.24.35-.2.35-.14.33-.1.3-.06.26-.04.21-.02.13-.01h5.84l.69-.05.59-.14.5-.21.41-.28.33-.32.27-.35.2-.36.15-.36.1-.35.07-.32.04-.28.02-.21V6.07h2.09l.14.01zm-6.47 14.25l-.23.33-.08.41.08.41.23.33.33.23.41.08.41-.08.33-.23.23-.33.08-.41-.08-.41-.23-.33-.33-.23-.41-.08-.41.08z"}},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    Python\n  "},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","flexWrap":"wrap","gap":"8px","marginTop":"20px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Enhance understanding with our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    For help, write to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://support.solidgate.com/support/tickets/new","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"support@solidgate.com."},"children":[]}]}]}]}]}],"sectionId":"/api"}],"sectionId":"/api"}]}]}},{"type":"separator","label":"Payments","content":null},{"type":"group","label":"Card payments","link":"/api/card-payments","routeSlug":"/api/card-payments","items":[{"label":"Charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/make-card-charge","routeSlug":"/api/card-payments/make-card-charge","metadata":{"seo":{"title":"Charge","description":"Basic operation withdraws funds from the cardholder’s account, with optional 3D Secure verification, and tokenizes the cardholder's data for future payments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"make-card-charge","name":"Charge","isWebhook":false,"pointer":"/paths/~1charge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Charge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic operation withdraws funds from the cardholder’s account, with optional 3D Secure verification, and tokenizes the cardholder's data for future payments."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1charge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_172","exampleIds":["paths/~1charge/post/requestBody/content/application~1json/examples/PAN Payment","paths/~1charge/post/requestBody/content/application~1json/examples/DPAN Payment","paths/~1charge/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1charge/post/requestBody/content/application~1json/examples/Subscription payment"]}},"schemaId":"schema_172","exampleIds":["paths/~1charge/post/requestBody/content/application~1json/examples/PAN Payment","paths/~1charge/post/requestBody/content/application~1json/examples/DPAN Payment","paths/~1charge/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1charge/post/requestBody/content/application~1json/examples/Subscription payment"],"pointer":"/paths/~1charge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/charge","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_172","exampleIds":["paths/~1charge/post/requestBody/content/application~1json/examples/PAN Payment","paths/~1charge/post/requestBody/content/application~1json/examples/DPAN Payment","paths/~1charge/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1charge/post/requestBody/content/application~1json/examples/Subscription payment"]}},"responseCodes":["200"],"pointer":"/charge","href":"card-payments/make-card-charge","openApiOperationId":"make-card-charge","summary":"Charge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"schemaId":"schema_172","exampleIds":["paths/~1charge/post/requestBody/content/application~1json/examples/PAN Payment","paths/~1charge/post/requestBody/content/application~1json/examples/DPAN Payment","paths/~1charge/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1charge/post/requestBody/content/application~1json/examples/Subscription payment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_172","exampleIds":["paths/~1charge/post/requestBody/content/application~1json/examples/PAN Payment","paths/~1charge/post/requestBody/content/application~1json/examples/DPAN Payment","paths/~1charge/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1charge/post/requestBody/content/application~1json/examples/Subscription payment"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_173","exampleIds":["paths/~1charge/post/responses/200/content/application~1json/examples/Success","paths/~1charge/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1charge/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1charge/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1charge/post/responses/200/content/application~1json/examples/Error X.XX"]}},"schemaId":"schema_173","exampleIds":["paths/~1charge/post/responses/200/content/application~1json/examples/Success","paths/~1charge/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1charge/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1charge/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1charge/post/responses/200/content/application~1json/examples/Error X.XX"]}],"pointer":"/paths/~1charge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_173","exampleIds":["paths/~1charge/post/responses/200/content/application~1json/examples/Success","paths/~1charge/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1charge/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1charge/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1charge/post/responses/200/content/application~1json/examples/Error X.XX"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_173","exampleIds":["paths/~1charge/post/responses/200/content/application~1json/examples/Success","paths/~1charge/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1charge/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1charge/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1charge/post/responses/200/content/application~1json/examples/Error X.XX"]}}}],"examples":[]}]}]}]},"httpPath":"/charge"},{"label":"Google Pay","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/make-google-pay","routeSlug":"/api/card-payments/make-google-pay","metadata":{"seo":{"title":"Google Pay","description":"An API request for Google Pay allows a merchant to initiate a Google Pay transaction, by sending a request to the Google Pay API with the required parameters such as amount, currency, and order identifier, which will be processed, and the response will be sent back with the transaction details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"make-google-pay","name":"Google Pay","isWebhook":false,"pointer":"/paths/~1google-pay/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Google Pay","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An API request for Google Pay allows a merchant to initiate a Google Pay transaction, by sending a request to the Google Pay API with the required parameters such as amount, currency, and order identifier, which will be processed, and the response will be sent back with the transaction details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1google-pay/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_174","exampleIds":["paths/~1google-pay/post/requestBody/content/application~1json/examples/Payment","paths/~1google-pay/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1google-pay/post/requestBody/content/application~1json/examples/Subscription payment"]}},"schemaId":"schema_174","exampleIds":["paths/~1google-pay/post/requestBody/content/application~1json/examples/Payment","paths/~1google-pay/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1google-pay/post/requestBody/content/application~1json/examples/Subscription payment"],"pointer":"/paths/~1google-pay/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/google-pay","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_174","exampleIds":["paths/~1google-pay/post/requestBody/content/application~1json/examples/Payment","paths/~1google-pay/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1google-pay/post/requestBody/content/application~1json/examples/Subscription payment"]}},"responseCodes":["200"],"pointer":"/google-pay","href":"card-payments/make-google-pay","openApiOperationId":"make-google-pay","summary":"Google Pay"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"schemaId":"schema_174","exampleIds":["paths/~1google-pay/post/requestBody/content/application~1json/examples/Payment","paths/~1google-pay/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1google-pay/post/requestBody/content/application~1json/examples/Subscription payment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_174","exampleIds":["paths/~1google-pay/post/requestBody/content/application~1json/examples/Payment","paths/~1google-pay/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1google-pay/post/requestBody/content/application~1json/examples/Subscription payment"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_175","exampleIds":["paths/~1google-pay/post/responses/200/content/application~1json/examples/Success","paths/~1google-pay/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1google-pay/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1google-pay/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1google-pay/post/responses/200/content/application~1json/examples/Error X.XX"]}},"schemaId":"schema_175","exampleIds":["paths/~1google-pay/post/responses/200/content/application~1json/examples/Success","paths/~1google-pay/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1google-pay/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1google-pay/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1google-pay/post/responses/200/content/application~1json/examples/Error X.XX"]}],"pointer":"/paths/~1google-pay/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_175","exampleIds":["paths/~1google-pay/post/responses/200/content/application~1json/examples/Success","paths/~1google-pay/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1google-pay/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1google-pay/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1google-pay/post/responses/200/content/application~1json/examples/Error X.XX"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_175","exampleIds":["paths/~1google-pay/post/responses/200/content/application~1json/examples/Success","paths/~1google-pay/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1google-pay/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1google-pay/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1google-pay/post/responses/200/content/application~1json/examples/Error X.XX"]}}}],"examples":[]}]}]}]},"httpPath":"/google-pay"},{"label":"Apple Pay","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/make-apple-pay","routeSlug":"/api/card-payments/make-apple-pay","metadata":{"seo":{"title":"Apple Pay","description":"An API request for Apple Pay allows a merchant to initiate an Apple Pay transaction, by sending a request to the Apple Pay API with the required parameters such as amount, currency, and order identifier, which will be processed, and the response will be sent back with the transaction details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"make-apple-pay","name":"Apple Pay","isWebhook":false,"pointer":"/paths/~1apple-pay/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apple Pay","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An API request for Apple Pay allows a merchant to initiate an Apple Pay transaction, by sending a request to the Apple Pay API with the required parameters such as amount, currency, and order identifier, which will be processed, and the response will be sent back with the transaction details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1apple-pay/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_176","exampleIds":["paths/~1apple-pay/post/requestBody/content/application~1json/examples/Payment","paths/~1apple-pay/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1apple-pay/post/requestBody/content/application~1json/examples/Subscription payment"]}},"schemaId":"schema_176","exampleIds":["paths/~1apple-pay/post/requestBody/content/application~1json/examples/Payment","paths/~1apple-pay/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1apple-pay/post/requestBody/content/application~1json/examples/Subscription payment"],"pointer":"/paths/~1apple-pay/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/apple-pay","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_176","exampleIds":["paths/~1apple-pay/post/requestBody/content/application~1json/examples/Payment","paths/~1apple-pay/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1apple-pay/post/requestBody/content/application~1json/examples/Subscription payment"]}},"responseCodes":["200"],"pointer":"/apple-pay","href":"card-payments/make-apple-pay","openApiOperationId":"make-apple-pay","summary":"Apple Pay"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"schemaId":"schema_176","exampleIds":["paths/~1apple-pay/post/requestBody/content/application~1json/examples/Payment","paths/~1apple-pay/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1apple-pay/post/requestBody/content/application~1json/examples/Subscription payment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_176","exampleIds":["paths/~1apple-pay/post/requestBody/content/application~1json/examples/Payment","paths/~1apple-pay/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1apple-pay/post/requestBody/content/application~1json/examples/Subscription payment"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_177","exampleIds":["paths/~1apple-pay/post/responses/200/content/application~1json/examples/Success","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error X.XX"]}},"schemaId":"schema_177","exampleIds":["paths/~1apple-pay/post/responses/200/content/application~1json/examples/Success","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error X.XX"]}],"pointer":"/paths/~1apple-pay/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_177","exampleIds":["paths/~1apple-pay/post/responses/200/content/application~1json/examples/Success","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error X.XX"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_177","exampleIds":["paths/~1apple-pay/post/responses/200/content/application~1json/examples/Success","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error X.XX"]}}}],"examples":[]}]}]}]},"httpPath":"/apple-pay"},{"label":"Incremental auth","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/increment-card-auth","routeSlug":"/api/card-payments/increment-card-auth","metadata":{"seo":{"title":"Incremental auth","description":"Incremental authorization operation creates additional authorization transactions on top of an estimated authorization to increase the total authorized amount for the order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"increment-card-auth","name":"Incremental auth","isWebhook":false,"pointer":"/paths/~1increment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Incremental auth","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incremental authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation creates additional authorization transactions on top of an estimated authorization to increase the total authorized amount for the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#payment-configuration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" conditions must be met."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum 50 increments allowed per order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation creates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"incremental"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within the same order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1increment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsIncrement","exampleIds":["paths/~1increment/post/requestBody/content/application~1json/examples/Payment incremental auth"]}},"schemaId":"components/schemas/RequestCardsIncrement","exampleIds":["paths/~1increment/post/requestBody/content/application~1json/examples/Payment incremental auth"],"pointer":"/paths/~1increment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/increment","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCardsIncrement","exampleIds":["paths/~1increment/post/requestBody/content/application~1json/examples/Payment incremental auth"]}},"responseCodes":["200"],"pointer":"/increment","href":"card-payments/increment-card-auth","openApiOperationId":"increment-card-auth","summary":"Incremental auth"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"schemaId":"components/schemas/RequestCardsIncrement","exampleIds":["paths/~1increment/post/requestBody/content/application~1json/examples/Payment incremental auth"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsIncrement","exampleIds":["paths/~1increment/post/requestBody/content/application~1json/examples/Payment incremental auth"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_178","exampleIds":["paths/~1increment/post/responses/200/content/application~1json/examples/Success","paths/~1increment/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.04 Card brand is not supported","paths/~1increment/post/responses/200/content/application~1json/examples/Error X.XX"]}},"schemaId":"schema_178","exampleIds":["paths/~1increment/post/responses/200/content/application~1json/examples/Success","paths/~1increment/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.04 Card brand is not supported","paths/~1increment/post/responses/200/content/application~1json/examples/Error X.XX"]}],"pointer":"/paths/~1increment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_178","exampleIds":["paths/~1increment/post/responses/200/content/application~1json/examples/Success","paths/~1increment/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.04 Card brand is not supported","paths/~1increment/post/responses/200/content/application~1json/examples/Error X.XX"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_178","exampleIds":["paths/~1increment/post/responses/200/content/application~1json/examples/Success","paths/~1increment/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.04 Card brand is not supported","paths/~1increment/post/responses/200/content/application~1json/examples/Error X.XX"]}}}],"examples":[]}]}]}]},"httpPath":"/increment"},{"label":"Recurring","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/make-card-recurring","routeSlug":"/api/card-payments/make-card-recurring","metadata":{"seo":{"title":"Recurring","description":"Method that allows you to initiate tokenized payments. In contrast to charge request, token previously received has to be sent in the request instead of cardholder data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"make-card-recurring","name":"Recurring","isWebhook":false,"pointer":"/paths/~1recurring/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recurring","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Method that allows you to initiate tokenized payments. In contrast to charge request, token previously received has to be sent in the request instead of cardholder data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1recurring/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_179","exampleIds":["paths/~1recurring/post/requestBody/content/application~1json/examples/Payment","paths/~1recurring/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1recurring/post/requestBody/content/application~1json/examples/Subscription payment"]}},"schemaId":"schema_179","exampleIds":["paths/~1recurring/post/requestBody/content/application~1json/examples/Payment","paths/~1recurring/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1recurring/post/requestBody/content/application~1json/examples/Subscription payment"],"pointer":"/paths/~1recurring/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/recurring","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_179","exampleIds":["paths/~1recurring/post/requestBody/content/application~1json/examples/Payment","paths/~1recurring/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1recurring/post/requestBody/content/application~1json/examples/Subscription payment"]}},"responseCodes":["200"],"pointer":"/recurring","href":"card-payments/make-card-recurring","openApiOperationId":"make-card-recurring","summary":"Recurring"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"schemaId":"schema_179","exampleIds":["paths/~1recurring/post/requestBody/content/application~1json/examples/Payment","paths/~1recurring/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1recurring/post/requestBody/content/application~1json/examples/Subscription payment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_179","exampleIds":["paths/~1recurring/post/requestBody/content/application~1json/examples/Payment","paths/~1recurring/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1recurring/post/requestBody/content/application~1json/examples/Subscription payment"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_180","exampleIds":["paths/~1recurring/post/responses/200/content/application~1json/examples/Success","paths/~1recurring/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1recurring/post/responses/200/content/application~1json/examples/Error X.XX"]}},"schemaId":"schema_180","exampleIds":["paths/~1recurring/post/responses/200/content/application~1json/examples/Success","paths/~1recurring/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1recurring/post/responses/200/content/application~1json/examples/Error X.XX"]}],"pointer":"/paths/~1recurring/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_180","exampleIds":["paths/~1recurring/post/responses/200/content/application~1json/examples/Success","paths/~1recurring/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1recurring/post/responses/200/content/application~1json/examples/Error X.XX"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_180","exampleIds":["paths/~1recurring/post/responses/200/content/application~1json/examples/Success","paths/~1recurring/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1recurring/post/responses/200/content/application~1json/examples/Error X.XX"]}}}],"examples":[]}]}]}]},"httpPath":"/recurring"},{"label":"Resign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/make-card-resign","routeSlug":"/api/card-payments/make-card-resign","metadata":{"seo":{"title":"Resign","description":"Resign one-click enables token-based transactions (1-click payments) with additional CVV verification, exclusive to PCI-DSS certified merchants."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"make-card-resign","name":"Resign","isWebhook":false,"pointer":"/paths/~1resign/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resign one-click enables token-based transactions (1-click payments) with additional CVV verification, exclusive to PCI-DSS certified merchants."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Implementing automated retry logic for declined operations is advisable, along with an additional strategy of triggering subsequent attempts at hourly intervals. It is important to ensure that the cumulative retry count remains under "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"120 attempts"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1resign/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_181","exampleIds":["paths/~1resign/post/requestBody/content/application~1json/examples/Payment","paths/~1resign/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1resign/post/requestBody/content/application~1json/examples/Subscription payment"]}},"schemaId":"schema_181","exampleIds":["paths/~1resign/post/requestBody/content/application~1json/examples/Payment","paths/~1resign/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1resign/post/requestBody/content/application~1json/examples/Subscription payment"],"pointer":"/paths/~1resign/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/resign","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_181","exampleIds":["paths/~1resign/post/requestBody/content/application~1json/examples/Payment","paths/~1resign/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1resign/post/requestBody/content/application~1json/examples/Subscription payment"]}},"responseCodes":["200"],"pointer":"/resign","href":"card-payments/make-card-resign","openApiOperationId":"make-card-resign","summary":"Resign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"schemaId":"schema_181","exampleIds":["paths/~1resign/post/requestBody/content/application~1json/examples/Payment","paths/~1resign/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1resign/post/requestBody/content/application~1json/examples/Subscription payment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_181","exampleIds":["paths/~1resign/post/requestBody/content/application~1json/examples/Payment","paths/~1resign/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1resign/post/requestBody/content/application~1json/examples/Subscription payment"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_182","exampleIds":["paths/~1resign/post/responses/200/content/application~1json/examples/Success","paths/~1resign/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1resign/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1resign/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1resign/post/responses/200/content/application~1json/examples/Error X.XX"]}},"schemaId":"schema_182","exampleIds":["paths/~1resign/post/responses/200/content/application~1json/examples/Success","paths/~1resign/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1resign/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1resign/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1resign/post/responses/200/content/application~1json/examples/Error X.XX"]}],"pointer":"/paths/~1resign/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_182","exampleIds":["paths/~1resign/post/responses/200/content/application~1json/examples/Success","paths/~1resign/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1resign/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1resign/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1resign/post/responses/200/content/application~1json/examples/Error X.XX"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_182","exampleIds":["paths/~1resign/post/responses/200/content/application~1json/examples/Success","paths/~1resign/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1resign/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1resign/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1resign/post/responses/200/content/application~1json/examples/Error X.XX"]}}}],"examples":[]}]}]}]},"httpPath":"/resign"},{"label":"Refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/refund-card-order","routeSlug":"/api/card-payments/refund-card-order","metadata":{"seo":{"title":"Refund","description":"Request for transferring funds back to the cardholder."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refund-card-order","name":"Refund","isWebhook":false,"pointer":"/paths/~1refund/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request for transferring funds back to the cardholder."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Implementing automated retry logic for declined operations is advisable, along with an additional strategy of triggering subsequent attempts at hourly intervals. It is important to ensure that the cumulative retry count remains under "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"120 attempts"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1refund/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsRefund","exampleIds":["paths/~1refund/post/requestBody/content/application~1json/examples/Refund"]}},"schemaId":"components/schemas/RequestCardsRefund","exampleIds":["paths/~1refund/post/requestBody/content/application~1json/examples/Refund"],"pointer":"/paths/~1refund/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/refund","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCardsRefund","exampleIds":["paths/~1refund/post/requestBody/content/application~1json/examples/Refund"]}},"responseCodes":["200"],"pointer":"/refund","href":"card-payments/refund-card-order","openApiOperationId":"refund-card-order","summary":"Refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"schemaId":"components/schemas/RequestCardsRefund","exampleIds":["paths/~1refund/post/requestBody/content/application~1json/examples/Refund"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsRefund","exampleIds":["paths/~1refund/post/requestBody/content/application~1json/examples/Refund"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_183","exampleIds":["paths/~1refund/post/responses/200/content/application~1json/examples/Success","paths/~1refund/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1refund/post/responses/200/content/application~1json/examples/Error X.XX"]}},"schemaId":"schema_183","exampleIds":["paths/~1refund/post/responses/200/content/application~1json/examples/Success","paths/~1refund/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1refund/post/responses/200/content/application~1json/examples/Error X.XX"]}],"pointer":"/paths/~1refund/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_183","exampleIds":["paths/~1refund/post/responses/200/content/application~1json/examples/Success","paths/~1refund/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1refund/post/responses/200/content/application~1json/examples/Error X.XX"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_183","exampleIds":["paths/~1refund/post/responses/200/content/application~1json/examples/Success","paths/~1refund/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1refund/post/responses/200/content/application~1json/examples/Error X.XX"]}}}],"examples":[]}]}]}]},"httpPath":"/refund"},{"label":"Void","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/void-card-order","routeSlug":"/api/card-payments/void-card-order","metadata":{"seo":{"title":"Void","description":"The void request serves to nullify pre-existing auth transactions by revoking the initial authorization. Be advised that the void method can only be executed for auth transactions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"void-card-order","name":"Void","isWebhook":false,"pointer":"/paths/~1void/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Void","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The void request serves to nullify pre-existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions by revoking the initial authorization. Be advised that the void method can only be executed for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Implementing automated retry logic for declined operations is advisable, along with an additional strategy of triggering subsequent attempts at hourly intervals. It is important to ensure that the cumulative retry count remains under "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"120 attempts"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1void/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsVoid"}},"schemaId":"components/schemas/RequestCardsVoid","pointer":"/paths/~1void/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/void","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCardsVoid"}},"responseCodes":["200"],"pointer":"/void","href":"card-payments/void-card-order","openApiOperationId":"void-card-order","summary":"Void"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"schemaId":"components/schemas/RequestCardsVoid","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsVoid"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184","exampleIds":["paths/~1void/post/responses/200/content/application~1json/examples/Success","paths/~1void/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1void/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1void/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1void/post/responses/200/content/application~1json/examples/Error X.XX"]}},"schemaId":"schema_184","exampleIds":["paths/~1void/post/responses/200/content/application~1json/examples/Success","paths/~1void/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1void/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1void/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1void/post/responses/200/content/application~1json/examples/Error X.XX"]}],"pointer":"/paths/~1void/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_184","exampleIds":["paths/~1void/post/responses/200/content/application~1json/examples/Success","paths/~1void/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1void/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1void/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1void/post/responses/200/content/application~1json/examples/Error X.XX"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184","exampleIds":["paths/~1void/post/responses/200/content/application~1json/examples/Success","paths/~1void/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1void/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1void/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1void/post/responses/200/content/application~1json/examples/Error X.XX"]}}}],"examples":[]}]}]}]},"httpPath":"/void"},{"label":"Settle","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/settle-card-order","routeSlug":"/api/card-payments/settle-card-order","metadata":{"seo":{"title":"Settle","description":"The settle method facilitates the settlement of previously auth transactions. Be advised that if the subsequent settle amount is less than the initial auth transaction amount, the difference will be refunded to the cardholder's account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"settle-card-order","name":"Settle","isWebhook":false,"pointer":"/paths/~1settle/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settle","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The settle method facilitates the settlement of previously "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions. Be advised that if the subsequent settle "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than the initial "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the difference will be refunded to the cardholder's account."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Implementing automated retry logic for declined operations is advisable, along with an additional strategy of triggering subsequent attempts at hourly intervals. It is important to ensure that the cumulative retry count remains under "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"120 attempts"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1settle/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsSettle"}},"schemaId":"components/schemas/RequestCardsSettle","pointer":"/paths/~1settle/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settle","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCardsSettle"}},"responseCodes":["200"],"pointer":"/settle","href":"card-payments/settle-card-order","openApiOperationId":"settle-card-order","summary":"Settle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"schemaId":"components/schemas/RequestCardsSettle","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsSettle"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_185","exampleIds":["paths/~1settle/post/responses/200/content/application~1json/examples/Success","paths/~1settle/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1settle/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1settle/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1settle/post/responses/200/content/application~1json/examples/Error X.XX"]}},"schemaId":"schema_185","exampleIds":["paths/~1settle/post/responses/200/content/application~1json/examples/Success","paths/~1settle/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1settle/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1settle/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1settle/post/responses/200/content/application~1json/examples/Error X.XX"]}],"pointer":"/paths/~1settle/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_185","exampleIds":["paths/~1settle/post/responses/200/content/application~1json/examples/Success","paths/~1settle/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1settle/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1settle/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1settle/post/responses/200/content/application~1json/examples/Error X.XX"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_185","exampleIds":["paths/~1settle/post/responses/200/content/application~1json/examples/Success","paths/~1settle/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1settle/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1settle/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1settle/post/responses/200/content/application~1json/examples/Error X.XX"]}}}],"examples":[]}]}]}]},"httpPath":"/settle"},{"label":"Check order status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/get-status-card-order","routeSlug":"/api/card-payments/get-status-card-order","metadata":{"seo":{"title":"Check order status","description":"The check order status request helps to retrieve the present status of a given order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-status-card-order","name":"Check order status","isWebhook":false,"pointer":"/paths/~1status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check order status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The check order status request helps to retrieve the present status of a given order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If a transaction is undergoing 3D Secure verification, the response indicates an order status of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsStatus"}},"schemaId":"components/schemas/RequestCardsStatus","pointer":"/paths/~1status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/status","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCardsStatus"}},"responseCodes":["200"],"pointer":"/status","href":"card-payments/get-status-card-order","openApiOperationId":"get-status-card-order","summary":"Check order status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"schemaId":"components/schemas/RequestCardsStatus","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsStatus"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_186","exampleIds":["paths/~1status/post/responses/200/content/application~1json/examples/Success","paths/~1status/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1status/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1status/post/responses/200/content/application~1json/examples/Error X.XX"]}},"schemaId":"schema_186","exampleIds":["paths/~1status/post/responses/200/content/application~1json/examples/Success","paths/~1status/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1status/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1status/post/responses/200/content/application~1json/examples/Error X.XX"]}],"pointer":"/paths/~1status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_186","exampleIds":["paths/~1status/post/responses/200/content/application~1json/examples/Success","paths/~1status/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1status/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1status/post/responses/200/content/application~1json/examples/Error X.XX"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_186","exampleIds":["paths/~1status/post/responses/200/content/application~1json/examples/Success","paths/~1status/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1status/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1status/post/responses/200/content/application~1json/examples/Error X.XX"]}}}],"examples":[]}]}]}]},"httpPath":"/status"},{"label":"Get ARN codes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/get-arn-codes","routeSlug":"/api/card-payments/get-arn-codes","metadata":{"seo":{"title":"Get ARN codes","description":"Get ARN codes request obtains ARN codes for specific orders, providing essential information about refunds, currencies, and transaction statuses."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-arn-codes","name":"Get ARN codes","isWebhook":false,"pointer":"/paths/~1arn-code/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get ARN codes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get ARN codes request obtains ARN codes for specific orders, providing essential information about refunds, currencies, and transaction statuses."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1arn-code/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsArn"}},"schemaId":"components/schemas/RequestCardsArn","pointer":"/paths/~1arn-code/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/arn-code","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCardsArn"}},"responseCodes":["200"],"pointer":"/arn-code","href":"card-payments/get-arn-codes","openApiOperationId":"get-arn-codes","summary":"Get ARN codes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments Live API"}],"schemaId":"components/schemas/RequestCardsArn","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsArn"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_187","exampleIds":["paths/~1arn-code/post/responses/200/content/application~1json/examples/Success","paths/~1arn-code/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1arn-code/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1arn-code/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"]}},"schemaId":"schema_187","exampleIds":["paths/~1arn-code/post/responses/200/content/application~1json/examples/Success","paths/~1arn-code/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1arn-code/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1arn-code/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"]}],"pointer":"/paths/~1arn-code/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_187","exampleIds":["paths/~1arn-code/post/responses/200/content/application~1json/examples/Success","paths/~1arn-code/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1arn-code/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1arn-code/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_187","exampleIds":["paths/~1arn-code/post/responses/200/content/application~1json/examples/Success","paths/~1arn-code/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1arn-code/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1arn-code/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"]}}}],"examples":[]}]}]}]},"httpPath":"/arn-code"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Updated card order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/card-payments/webhook-card-order-status","routeSlug":"/api/card-payments/webhook-card-order-status","metadata":{"seo":{"title":"Updated card order","description":"Webhooks allow merchants to securely receive real-time notifications in card order status changes, for example, from processing to auth_failed, and automatically trigger actions or updates in their own systems based on those events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-card-order-status","name":"Updated card order","isWebhook":true,"pointer":"/paths/CardsOrderStatus/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updated card order","badges":[{"name":"Event","color":"purple"}],"isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allow merchants to securely receive real-time notifications in card order status changes, for example, from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and automatically trigger actions or updates in their own systems based on those events."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Duplicate webhook events can occur. Implement "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#event-handling","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"idempotency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" on your end to avoid processing the same event twice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_188","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true},{"name":"solidgate-event-id","in":"header","schemaId":"schema_189","description":"Unique event identifier.","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1"},{"name":"solidgate-event-created-at","in":"header","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event creation time in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with milliseconds."},"children":[]}]}]}],"required":true,"example":"2025-06-05T12:34:56.789Z"},{"name":"solidgate-event-type","in":"header","schemaId":"schema_189","description":"Event type, indicating the specific event that occurred.","required":true,"example":"card_gate.order.updated"}],"pointer":"/paths/CardsOrderStatus/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookOrderStatus","exampleIds":["paths/CardsOrderStatus/post/requestBody/content/application~1json/examples/Updated card order"]}},"schemaId":"components/schemas/RequestCardsWebhookOrderStatus","exampleIds":["paths/CardsOrderStatus/post/requestBody/content/application~1json/examples/Updated card order"],"pointer":"/paths/CardsOrderStatus/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"CardsOrderStatus","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"wh_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchantWebhook"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"},{"name":"solidgate-event-id","in":"header","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1","schemaId":"schema_189"},{"name":"solidgate-event-created-at","in":"header","required":true,"example":"2025-06-05T12:34:56.789Z","schemaId":"schema_190"},{"name":"solidgate-event-type","in":"header","required":true,"example":"card_gate.order.updated","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookOrderStatus","exampleIds":["paths/CardsOrderStatus/post/requestBody/content/application~1json/examples/Updated card order"]}},"responseCodes":["2XX"],"pointer":"CardsOrderStatus","href":"card-payments/webhook-card-order-status","openApiOperationId":"webhook-card-order-status","summary":"Updated card order"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"schemaId":"components/schemas/RequestCardsWebhookOrderStatus","exampleIds":["paths/CardsOrderStatus/post/requestBody/content/application~1json/examples/Updated card order"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookOrderStatus","exampleIds":["paths/CardsOrderStatus/post/requestBody/content/application~1json/examples/Updated card order"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Return any 2XX status to confirm successful data receipt"}],"pointer":"/paths/CardsOrderStatus/post/responses"}],"panels":[]}]},"badges":[{"name":"Event","color":"purple"}],"httpPath":"CardsOrderStatus"},{"label":"Created network token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/card-payments/webhook-network-token-created","routeSlug":"/api/card-payments/webhook-network-token-created","metadata":{"seo":{"title":"Created network token","description":"Webhooks provide merchants with real-time notifications, indicating that the network token associated with a payment card has been issued by Visa or Mastercard. Merchants can then automatically update their systems based on these notifications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-network-token-created","name":"Created network token","isWebhook":true,"pointer":"/paths/NetworkTokenCreated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Created network token","badges":[{"name":"Event","color":"purple"}],"isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provide merchants with real-time notifications, indicating that the network token associated with a payment card has been issued by Visa or Mastercard. Merchants can then automatically update their systems based on these notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Duplicate webhook events can occur. Implement "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#event-handling","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"idempotency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" on your end to avoid processing the same event twice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_188","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true},{"name":"solidgate-event-id","in":"header","schemaId":"schema_189","description":"Unique event identifier.","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1"},{"name":"solidgate-event-created-at","in":"header","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event creation time in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with milliseconds."},"children":[]}]}]}],"required":true,"example":"2025-06-05T12:34:56.789Z"},{"name":"solidgate-event-type","in":"header","schemaId":"schema_189","description":"Event type, indicating the specific event that occurred.","required":true,"example":"card.network_token.created"}],"pointer":"/paths/NetworkTokenCreated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookNetworkTokenCreated","exampleIds":["paths/NetworkTokenCreated/post/requestBody/content/application~1json/examples/Created network token"]}},"schemaId":"components/schemas/RequestCardsWebhookNetworkTokenCreated","exampleIds":["paths/NetworkTokenCreated/post/requestBody/content/application~1json/examples/Created network token"],"pointer":"/paths/NetworkTokenCreated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"NetworkTokenCreated","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"wh_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchantWebhook"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"},{"name":"solidgate-event-id","in":"header","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1","schemaId":"schema_189"},{"name":"solidgate-event-created-at","in":"header","required":true,"example":"2025-06-05T12:34:56.789Z","schemaId":"schema_190"},{"name":"solidgate-event-type","in":"header","required":true,"example":"card.network_token.created","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookNetworkTokenCreated","exampleIds":["paths/NetworkTokenCreated/post/requestBody/content/application~1json/examples/Created network token"]}},"responseCodes":["2XX"],"pointer":"NetworkTokenCreated","href":"card-payments/webhook-network-token-created","openApiOperationId":"webhook-network-token-created","summary":"Created network token"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"schemaId":"components/schemas/RequestCardsWebhookNetworkTokenCreated","exampleIds":["paths/NetworkTokenCreated/post/requestBody/content/application~1json/examples/Created network token"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookNetworkTokenCreated","exampleIds":["paths/NetworkTokenCreated/post/requestBody/content/application~1json/examples/Created network token"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Return any 2XX status to confirm successful data receipt"}],"pointer":"/paths/NetworkTokenCreated/post/responses"}],"panels":[]}]},"badges":[{"name":"Event","color":"purple"}],"httpPath":"NetworkTokenCreated"},{"label":"Updated network token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/card-payments/webhook-network-token-updated","routeSlug":"/api/card-payments/webhook-network-token-updated","metadata":{"seo":{"title":"Updated network token","description":"Webhooks provide merchants with real-time notifications when the network token associated with a payment card is updated by Visa or Mastercard. These notifications allow merchants to automatically update their systems based on the events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-network-token-updated","name":"Updated network token","isWebhook":true,"pointer":"/paths/NetworkTokenUpdated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updated network token","badges":[{"name":"Event","color":"purple"}],"isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provide merchants with real-time notifications when the network token associated with a payment card is updated by Visa or Mastercard. These notifications allow merchants to automatically update their systems based on the events."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Duplicate webhook events can occur. Implement "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#event-handling","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"idempotency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" on your end to avoid processing the same event twice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_188","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true},{"name":"solidgate-event-id","in":"header","schemaId":"schema_189","description":"Unique event identifier.","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1"},{"name":"solidgate-event-created-at","in":"header","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event creation time in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with milliseconds."},"children":[]}]}]}],"required":true,"example":"2025-06-05T12:34:56.789Z"},{"name":"solidgate-event-type","in":"header","schemaId":"schema_189","description":"Event type, indicating the specific event that occurred.","required":true,"example":"card.network_token.updated"}],"pointer":"/paths/NetworkTokenUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookNetworkTokenUpdated","exampleIds":["paths/NetworkTokenUpdated/post/requestBody/content/application~1json/examples/Updated network token"]}},"schemaId":"components/schemas/RequestCardsWebhookNetworkTokenUpdated","exampleIds":["paths/NetworkTokenUpdated/post/requestBody/content/application~1json/examples/Updated network token"],"pointer":"/paths/NetworkTokenUpdated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"NetworkTokenUpdated","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"wh_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchantWebhook"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"},{"name":"solidgate-event-id","in":"header","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1","schemaId":"schema_189"},{"name":"solidgate-event-created-at","in":"header","required":true,"example":"2025-06-05T12:34:56.789Z","schemaId":"schema_190"},{"name":"solidgate-event-type","in":"header","required":true,"example":"card.network_token.updated","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookNetworkTokenUpdated","exampleIds":["paths/NetworkTokenUpdated/post/requestBody/content/application~1json/examples/Updated network token"]}},"responseCodes":["2XX"],"pointer":"NetworkTokenUpdated","href":"card-payments/webhook-network-token-updated","openApiOperationId":"webhook-network-token-updated","summary":"Updated network token"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"schemaId":"components/schemas/RequestCardsWebhookNetworkTokenUpdated","exampleIds":["paths/NetworkTokenUpdated/post/requestBody/content/application~1json/examples/Updated network token"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookNetworkTokenUpdated","exampleIds":["paths/NetworkTokenUpdated/post/requestBody/content/application~1json/examples/Updated network token"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Return any 2XX status to confirm successful data receipt"}],"pointer":"/paths/NetworkTokenUpdated/post/responses"}],"panels":[]}]},"badges":[{"name":"Event","color":"purple"}],"httpPath":"NetworkTokenUpdated"},{"label":"Received dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/card-payments/webhook-chargeback","routeSlug":"/api/card-payments/webhook-chargeback","metadata":{"seo":{"title":"Received dispute","description":"Webhooks for chargebacks allow merchants to securely receive real-time notifications of chargeback events and automatically trigger actions or updates in their own systems based on those events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-chargeback","name":"Received dispute","isWebhook":true,"pointer":"/paths/Chargeback/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Received dispute","badges":[{"name":"Event","color":"purple"}],"isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for chargebacks allow merchants to securely receive real-time notifications of chargeback events and automatically trigger actions or updates in their own systems based on those events."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Duplicate webhook events can occur. Implement "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#event-handling","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"idempotency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" on your end to avoid processing the same event twice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_188","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true},{"name":"solidgate-event-id","in":"header","schemaId":"schema_189","description":"Unique event identifier.","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1"},{"name":"solidgate-event-created-at","in":"header","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event creation time in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with milliseconds."},"children":[]}]}]}],"required":true,"example":"2025-06-05T12:34:56.789Z"},{"name":"solidgate-event-type","in":"header","schemaId":"schema_189","description":"Event type, indicating the specific event that occurred.","required":true,"example":"card_gate.chargeback.received"}],"pointer":"/paths/Chargeback/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookChargeback","exampleIds":["paths/Chargeback/post/requestBody/content/application~1json/examples/Received dispute"]}},"schemaId":"components/schemas/RequestCardsWebhookChargeback","exampleIds":["paths/Chargeback/post/requestBody/content/application~1json/examples/Received dispute"],"pointer":"/paths/Chargeback/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Chargeback","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"wh_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchantWebhook"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"},{"name":"solidgate-event-id","in":"header","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1","schemaId":"schema_189"},{"name":"solidgate-event-created-at","in":"header","required":true,"example":"2025-06-05T12:34:56.789Z","schemaId":"schema_190"},{"name":"solidgate-event-type","in":"header","required":true,"example":"card_gate.chargeback.received","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookChargeback","exampleIds":["paths/Chargeback/post/requestBody/content/application~1json/examples/Received dispute"]}},"responseCodes":["2XX"],"pointer":"Chargeback","href":"card-payments/webhook-chargeback","openApiOperationId":"webhook-chargeback","summary":"Received dispute"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"schemaId":"components/schemas/RequestCardsWebhookChargeback","exampleIds":["paths/Chargeback/post/requestBody/content/application~1json/examples/Received dispute"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookChargeback","exampleIds":["paths/Chargeback/post/requestBody/content/application~1json/examples/Received dispute"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Return any 2XX status to confirm successful data receipt"}],"pointer":"/paths/Chargeback/post/responses"}],"panels":[]}]},"badges":[{"name":"Event","color":"purple"}],"httpPath":"Chargeback"},{"label":"Received prevention alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/card-payments/webhook-alert-prevent","routeSlug":"/api/card-payments/webhook-alert-prevent","metadata":{"seo":{"title":"Received prevention alert","description":"Webhooks enable to preemptively identify and resolve potential issues, thereby preventing the generation of alert."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-alert-prevent","name":"Received prevention alert","isWebhook":true,"pointer":"/paths/CardPreventAlert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Received prevention alert","badges":[{"name":"Event","color":"purple"}],"isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enable to preemptively identify and resolve potential issues, thereby preventing the generation of alert."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Duplicate webhook events can occur. Implement "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#event-handling","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"idempotency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" on your end to avoid processing the same event twice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_188","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true},{"name":"solidgate-event-id","in":"header","schemaId":"schema_189","description":"Unique event identifier.","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1"},{"name":"solidgate-event-created-at","in":"header","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event creation time in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with milliseconds."},"children":[]}]}]}],"required":true,"example":"2025-06-05T12:34:56.789Z"},{"name":"solidgate-event-type","in":"header","schemaId":"schema_189","description":"Event type, indicating the specific event that occurred.","required":true,"example":"card_gate.prevention_alert.received"}],"pointer":"/paths/CardPreventAlert/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookPreventAlert","exampleIds":["paths/CardPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert"]}},"schemaId":"components/schemas/RequestCardsWebhookPreventAlert","exampleIds":["paths/CardPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert"],"pointer":"/paths/CardPreventAlert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"CardPreventAlert","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"wh_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchantWebhook"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"},{"name":"solidgate-event-id","in":"header","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1","schemaId":"schema_189"},{"name":"solidgate-event-created-at","in":"header","required":true,"example":"2025-06-05T12:34:56.789Z","schemaId":"schema_190"},{"name":"solidgate-event-type","in":"header","required":true,"example":"card_gate.prevention_alert.received","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookPreventAlert","exampleIds":["paths/CardPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert"]}},"responseCodes":["2XX"],"pointer":"CardPreventAlert","href":"card-payments/webhook-alert-prevent","openApiOperationId":"webhook-alert-prevent","summary":"Received prevention alert"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"schemaId":"components/schemas/RequestCardsWebhookPreventAlert","exampleIds":["paths/CardPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookPreventAlert","exampleIds":["paths/CardPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Return any 2XX status to confirm successful data receipt"}],"pointer":"/paths/CardPreventAlert/post/responses"}],"panels":[]}]},"badges":[{"name":"Event","color":"purple"}],"httpPath":"CardPreventAlert"},{"label":"Received fraud alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/card-payments/webhook-fraud-alert","routeSlug":"/api/card-payments/webhook-fraud-alert","metadata":{"seo":{"title":"Received fraud alert","description":"Webhooks for fraud alerts allow merchants to securely receive real-time notifications of fraud reported by card schemes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-fraud-alert","name":"Received fraud alert","isWebhook":true,"pointer":"/paths/FraudAlert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Received fraud alert","badges":[{"name":"Event","color":"purple"}],"isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for fraud alerts allow merchants to securely receive real-time notifications of fraud reported by card schemes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Duplicate webhook events can occur. Implement "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#event-handling","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"idempotency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" on your end to avoid processing the same event twice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_188","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true},{"name":"solidgate-event-id","in":"header","schemaId":"schema_189","description":"Unique event identifier.","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1"},{"name":"solidgate-event-created-at","in":"header","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event creation time in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with milliseconds."},"children":[]}]}]}],"required":true,"example":"2025-06-05T12:34:56.789Z"},{"name":"solidgate-event-type","in":"header","schemaId":"schema_189","description":"Event type, indicating the specific event that occurred.","required":true,"example":"card_gate.fraud_alert.received"}],"pointer":"/paths/FraudAlert/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookFraudAlert","exampleIds":["paths/FraudAlert/post/requestBody/content/application~1json/examples/Received fraud alert"]}},"schemaId":"components/schemas/RequestCardsWebhookFraudAlert","exampleIds":["paths/FraudAlert/post/requestBody/content/application~1json/examples/Received fraud alert"],"pointer":"/paths/FraudAlert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"FraudAlert","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"wh_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchantWebhook"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"},{"name":"solidgate-event-id","in":"header","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1","schemaId":"schema_189"},{"name":"solidgate-event-created-at","in":"header","required":true,"example":"2025-06-05T12:34:56.789Z","schemaId":"schema_190"},{"name":"solidgate-event-type","in":"header","required":true,"example":"card_gate.fraud_alert.received","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookFraudAlert","exampleIds":["paths/FraudAlert/post/requestBody/content/application~1json/examples/Received fraud alert"]}},"responseCodes":["2XX"],"pointer":"FraudAlert","href":"card-payments/webhook-fraud-alert","openApiOperationId":"webhook-fraud-alert","summary":"Received fraud alert"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"schemaId":"components/schemas/RequestCardsWebhookFraudAlert","exampleIds":["paths/FraudAlert/post/requestBody/content/application~1json/examples/Received fraud alert"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCardsWebhookFraudAlert","exampleIds":["paths/FraudAlert/post/requestBody/content/application~1json/examples/Received fraud alert"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Return any 2XX status to confirm successful data receipt"}],"pointer":"/paths/FraudAlert/post/responses"}],"panels":[]}]},"badges":[{"name":"Event","color":"purple"}],"httpPath":"FraudAlert"}],"content":{"contentType":"group","meta":{"name":"Card payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card payments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solidgate API for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card payments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows merchants to securely integrate with a payment gateway to process and manage card transactions."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/charge","summary":"Charge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-payments/make-card-charge","deprecated":false},{"title":"/google-pay","summary":"Google Pay","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-payments/make-google-pay","deprecated":false},{"title":"/apple-pay","summary":"Apple Pay","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-payments/make-apple-pay","deprecated":false},{"title":"/increment","summary":"Incremental auth","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-payments/increment-card-auth","deprecated":false},{"title":"/recurring","summary":"Recurring","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-payments/make-card-recurring","deprecated":false},{"title":"/resign","summary":"Resign","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-payments/make-card-resign","deprecated":false},{"title":"/refund","summary":"Refund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-payments/refund-card-order","deprecated":false},{"title":"/void","summary":"Void","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-payments/void-card-order","deprecated":false},{"title":"/settle","summary":"Settle","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-payments/settle-card-order","deprecated":false},{"title":"/status","summary":"Check order status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-payments/get-status-card-order","deprecated":false},{"title":"/arn-code","summary":"Get ARN codes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-payments/get-arn-codes","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"CardsOrderStatus","summary":"Updated card order","prefix":{"name":"post","color":"post"},"badges":[{"name":"Event","color":"purple"}],"link":"/card-payments/webhook-card-order-status","deprecated":false},{"title":"NetworkTokenCreated","summary":"Created network token","prefix":{"name":"post","color":"post"},"badges":[{"name":"Event","color":"purple"}],"link":"/card-payments/webhook-network-token-created","deprecated":false},{"title":"NetworkTokenUpdated","summary":"Updated network token","prefix":{"name":"post","color":"post"},"badges":[{"name":"Event","color":"purple"}],"link":"/card-payments/webhook-network-token-updated","deprecated":false},{"title":"Chargeback","summary":"Received dispute","prefix":{"name":"post","color":"post"},"badges":[{"name":"Event","color":"purple"}],"link":"/card-payments/webhook-chargeback","deprecated":false},{"title":"CardPreventAlert","summary":"Received prevention alert","prefix":{"name":"post","color":"post"},"badges":[{"name":"Event","color":"purple"}],"link":"/card-payments/webhook-alert-prevent","deprecated":false},{"title":"FraudAlert","summary":"Received fraud alert","prefix":{"name":"post","color":"post"},"badges":[{"name":"Event","color":"purple"}],"link":"/card-payments/webhook-fraud-alert","deprecated":false}]}]}]}]}},{"type":"group","label":"Alternative payment methods","link":"/api/alternative-payment-methods","routeSlug":"/api/alternative-payment-methods","items":[{"label":"Init payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/alternative-payment-methods/create-apm-init-payment","routeSlug":"/api/alternative-payment-methods/create-apm-init-payment","metadata":{"seo":{"title":"Init payment","description":"Operation for the initiation of a payment using an APMs, performs order creation and prepares the transaction for payment, allowing the customer to proceed with the payment process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-apm-init-payment","name":"Init payment","isWebhook":false,"pointer":"/paths/~1init-payment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Init payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operation for the initiation of a payment using an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", performs order creation and prepares the transaction for payment, allowing the customer to proceed with the payment process."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1init-payment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_191","exampleIds":["paths/~1init-payment/post/requestBody/content/application~1json/examples/PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik Pay Later","paths/~1init-payment/post/requestBody/content/application~1json/examples/Bizum","paths/~1init-payment/post/requestBody/content/application~1json/examples/Boleto","paths/~1init-payment/post/requestBody/content/application~1json/examples/Cash App Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Efecty","paths/~1init-payment/post/requestBody/content/application~1json/examples/GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Ideal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/MobilePay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Multibanco","paths/~1init-payment/post/requestBody/content/application~1json/examples/OXXO","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pay by Bank","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix QR","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix Automático","paths/~1init-payment/post/requestBody/content/application~1json/examples/Przelewy24","paths/~1init-payment/post/requestBody/content/application~1json/examples/PSE","paths/~1init-payment/post/requestBody/content/application~1json/examples/Sencillito","paths/~1init-payment/post/requestBody/content/application~1json/examples/Servipag","paths/~1init-payment/post/requestBody/content/application~1json/examples/SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Webpay","paths/~1init-payment/post/requestBody/content/application~1json/examples/WeChat Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik Pay Later","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Boleto","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Efecty","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Ideal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MobilePay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Multibanco","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment OXXO","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pay by Bank","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pix QR","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Przelewy24","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PSE","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Sencillito","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Servipag","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Webpay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay"]}},"schemaId":"schema_191","exampleIds":["paths/~1init-payment/post/requestBody/content/application~1json/examples/PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik Pay Later","paths/~1init-payment/post/requestBody/content/application~1json/examples/Bizum","paths/~1init-payment/post/requestBody/content/application~1json/examples/Boleto","paths/~1init-payment/post/requestBody/content/application~1json/examples/Cash App Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Efecty","paths/~1init-payment/post/requestBody/content/application~1json/examples/GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Ideal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/MobilePay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Multibanco","paths/~1init-payment/post/requestBody/content/application~1json/examples/OXXO","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pay by Bank","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix QR","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix Automático","paths/~1init-payment/post/requestBody/content/application~1json/examples/Przelewy24","paths/~1init-payment/post/requestBody/content/application~1json/examples/PSE","paths/~1init-payment/post/requestBody/content/application~1json/examples/Sencillito","paths/~1init-payment/post/requestBody/content/application~1json/examples/Servipag","paths/~1init-payment/post/requestBody/content/application~1json/examples/SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Webpay","paths/~1init-payment/post/requestBody/content/application~1json/examples/WeChat Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik Pay Later","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Boleto","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Efecty","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Ideal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MobilePay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Multibanco","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment OXXO","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pay by Bank","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pix QR","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Przelewy24","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PSE","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Sencillito","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Servipag","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Webpay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay"],"pointer":"/paths/~1init-payment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/init-payment","servers":[{"url":"https://gate.solidgate.com/api/v1","description":"APM payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_191","exampleIds":["paths/~1init-payment/post/requestBody/content/application~1json/examples/PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik Pay Later","paths/~1init-payment/post/requestBody/content/application~1json/examples/Bizum","paths/~1init-payment/post/requestBody/content/application~1json/examples/Boleto","paths/~1init-payment/post/requestBody/content/application~1json/examples/Cash App Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Efecty","paths/~1init-payment/post/requestBody/content/application~1json/examples/GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Ideal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/MobilePay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Multibanco","paths/~1init-payment/post/requestBody/content/application~1json/examples/OXXO","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pay by Bank","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix QR","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix Automático","paths/~1init-payment/post/requestBody/content/application~1json/examples/Przelewy24","paths/~1init-payment/post/requestBody/content/application~1json/examples/PSE","paths/~1init-payment/post/requestBody/content/application~1json/examples/Sencillito","paths/~1init-payment/post/requestBody/content/application~1json/examples/Servipag","paths/~1init-payment/post/requestBody/content/application~1json/examples/SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Webpay","paths/~1init-payment/post/requestBody/content/application~1json/examples/WeChat Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik Pay Later","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Boleto","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Efecty","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Ideal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MobilePay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Multibanco","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment OXXO","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pay by Bank","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pix QR","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Przelewy24","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PSE","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Sencillito","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Servipag","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Webpay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay"]}},"responseCodes":["200"],"pointer":"/init-payment","href":"alternative-payment-methods/create-apm-init-payment","openApiOperationId":"create-apm-init-payment","summary":"Init payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://gate.solidgate.com/api/v1","description":"APM payments Live API"}],"schemaId":"schema_191","exampleIds":["paths/~1init-payment/post/requestBody/content/application~1json/examples/PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik Pay Later","paths/~1init-payment/post/requestBody/content/application~1json/examples/Bizum","paths/~1init-payment/post/requestBody/content/application~1json/examples/Boleto","paths/~1init-payment/post/requestBody/content/application~1json/examples/Cash App Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Efecty","paths/~1init-payment/post/requestBody/content/application~1json/examples/GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Ideal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/MobilePay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Multibanco","paths/~1init-payment/post/requestBody/content/application~1json/examples/OXXO","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pay by Bank","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix QR","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix Automático","paths/~1init-payment/post/requestBody/content/application~1json/examples/Przelewy24","paths/~1init-payment/post/requestBody/content/application~1json/examples/PSE","paths/~1init-payment/post/requestBody/content/application~1json/examples/Sencillito","paths/~1init-payment/post/requestBody/content/application~1json/examples/Servipag","paths/~1init-payment/post/requestBody/content/application~1json/examples/SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Webpay","paths/~1init-payment/post/requestBody/content/application~1json/examples/WeChat Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik Pay Later","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Boleto","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Efecty","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Ideal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MobilePay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Multibanco","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment OXXO","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pay by Bank","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pix QR","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Przelewy24","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PSE","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Sencillito","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Servipag","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Webpay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_191","exampleIds":["paths/~1init-payment/post/requestBody/content/application~1json/examples/PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik Pay Later","paths/~1init-payment/post/requestBody/content/application~1json/examples/Bizum","paths/~1init-payment/post/requestBody/content/application~1json/examples/Boleto","paths/~1init-payment/post/requestBody/content/application~1json/examples/Cash App Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Efecty","paths/~1init-payment/post/requestBody/content/application~1json/examples/GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Ideal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/MobilePay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Multibanco","paths/~1init-payment/post/requestBody/content/application~1json/examples/OXXO","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pay by Bank","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix QR","paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix Automático","paths/~1init-payment/post/requestBody/content/application~1json/examples/Przelewy24","paths/~1init-payment/post/requestBody/content/application~1json/examples/PSE","paths/~1init-payment/post/requestBody/content/application~1json/examples/Sencillito","paths/~1init-payment/post/requestBody/content/application~1json/examples/Servipag","paths/~1init-payment/post/requestBody/content/application~1json/examples/SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Webpay","paths/~1init-payment/post/requestBody/content/application~1json/examples/WeChat Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik Pay Later","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Boleto","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Efecty","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Ideal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MobilePay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Multibanco","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment OXXO","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pay by Bank","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pix QR","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Przelewy24","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PSE","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Sencillito","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Servipag","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Webpay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment PayPal","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Alipay","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Blik","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment GCash","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Klarna","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment MB WAY","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment SmartPix","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment UPI","paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_192","exampleIds":["paths/~1init-payment/post/responses/200/content/application~1json/examples/PayPal","paths/~1init-payment/post/responses/200/content/application~1json/examples/Alipay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Blik","paths/~1init-payment/post/responses/200/content/application~1json/examples/Blik Pay Later","paths/~1init-payment/post/responses/200/content/application~1json/examples/Bizum","paths/~1init-payment/post/responses/200/content/application~1json/examples/Boleto","paths/~1init-payment/post/responses/200/content/application~1json/examples/Cash App Pay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Efecty","paths/~1init-payment/post/responses/200/content/application~1json/examples/GCash","paths/~1init-payment/post/responses/200/content/application~1json/examples/Ideal","paths/~1init-payment/post/responses/200/content/application~1json/examples/Klarna","paths/~1init-payment/post/responses/200/content/application~1json/examples/MB WAY","paths/~1init-payment/post/responses/200/content/application~1json/examples/Mercado Pago","paths/~1init-payment/post/responses/200/content/application~1json/examples/MobilePay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Multibanco","paths/~1init-payment/post/responses/200/content/application~1json/examples/OXXO","paths/~1init-payment/post/responses/200/content/application~1json/examples/Pay by Bank","paths/~1init-payment/post/responses/200/content/application~1json/examples/Pix QR","paths/~1init-payment/post/responses/200/content/application~1json/examples/Pix Automático","paths/~1init-payment/post/responses/200/content/application~1json/examples/Przelewy24","paths/~1init-payment/post/responses/200/content/application~1json/examples/PSE","paths/~1init-payment/post/responses/200/content/application~1json/examples/Sencillito","paths/~1init-payment/post/responses/200/content/application~1json/examples/Servipag","paths/~1init-payment/post/responses/200/content/application~1json/examples/SmartPix","paths/~1init-payment/post/responses/200/content/application~1json/examples/UPI","paths/~1init-payment/post/responses/200/content/application~1json/examples/Webpay","paths/~1init-payment/post/responses/200/content/application~1json/examples/WeChat Pay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1init-payment/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1init-payment/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1init-payment/post/responses/200/content/application~1json/examples/Error X.XX"]}},"schemaId":"schema_192","exampleIds":["paths/~1init-payment/post/responses/200/content/application~1json/examples/PayPal","paths/~1init-payment/post/responses/200/content/application~1json/examples/Alipay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Blik","paths/~1init-payment/post/responses/200/content/application~1json/examples/Blik Pay Later","paths/~1init-payment/post/responses/200/content/application~1json/examples/Bizum","paths/~1init-payment/post/responses/200/content/application~1json/examples/Boleto","paths/~1init-payment/post/responses/200/content/application~1json/examples/Cash App Pay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Efecty","paths/~1init-payment/post/responses/200/content/application~1json/examples/GCash","paths/~1init-payment/post/responses/200/content/application~1json/examples/Ideal","paths/~1init-payment/post/responses/200/content/application~1json/examples/Klarna","paths/~1init-payment/post/responses/200/content/application~1json/examples/MB WAY","paths/~1init-payment/post/responses/200/content/application~1json/examples/Mercado Pago","paths/~1init-payment/post/responses/200/content/application~1json/examples/MobilePay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Multibanco","paths/~1init-payment/post/responses/200/content/application~1json/examples/OXXO","paths/~1init-payment/post/responses/200/content/application~1json/examples/Pay by Bank","paths/~1init-payment/post/responses/200/content/application~1json/examples/Pix QR","paths/~1init-payment/post/responses/200/content/application~1json/examples/Pix Automático","paths/~1init-payment/post/responses/200/content/application~1json/examples/Przelewy24","paths/~1init-payment/post/responses/200/content/application~1json/examples/PSE","paths/~1init-payment/post/responses/200/content/application~1json/examples/Sencillito","paths/~1init-payment/post/responses/200/content/application~1json/examples/Servipag","paths/~1init-payment/post/responses/200/content/application~1json/examples/SmartPix","paths/~1init-payment/post/responses/200/content/application~1json/examples/UPI","paths/~1init-payment/post/responses/200/content/application~1json/examples/Webpay","paths/~1init-payment/post/responses/200/content/application~1json/examples/WeChat Pay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1init-payment/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1init-payment/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1init-payment/post/responses/200/content/application~1json/examples/Error X.XX"]}],"pointer":"/paths/~1init-payment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_192","exampleIds":["paths/~1init-payment/post/responses/200/content/application~1json/examples/PayPal","paths/~1init-payment/post/responses/200/content/application~1json/examples/Alipay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Blik","paths/~1init-payment/post/responses/200/content/application~1json/examples/Blik Pay Later","paths/~1init-payment/post/responses/200/content/application~1json/examples/Bizum","paths/~1init-payment/post/responses/200/content/application~1json/examples/Boleto","paths/~1init-payment/post/responses/200/content/application~1json/examples/Cash App Pay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Efecty","paths/~1init-payment/post/responses/200/content/application~1json/examples/GCash","paths/~1init-payment/post/responses/200/content/application~1json/examples/Ideal","paths/~1init-payment/post/responses/200/content/application~1json/examples/Klarna","paths/~1init-payment/post/responses/200/content/application~1json/examples/MB WAY","paths/~1init-payment/post/responses/200/content/application~1json/examples/Mercado Pago","paths/~1init-payment/post/responses/200/content/application~1json/examples/MobilePay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Multibanco","paths/~1init-payment/post/responses/200/content/application~1json/examples/OXXO","paths/~1init-payment/post/responses/200/content/application~1json/examples/Pay by Bank","paths/~1init-payment/post/responses/200/content/application~1json/examples/Pix QR","paths/~1init-payment/post/responses/200/content/application~1json/examples/Pix Automático","paths/~1init-payment/post/responses/200/content/application~1json/examples/Przelewy24","paths/~1init-payment/post/responses/200/content/application~1json/examples/PSE","paths/~1init-payment/post/responses/200/content/application~1json/examples/Sencillito","paths/~1init-payment/post/responses/200/content/application~1json/examples/Servipag","paths/~1init-payment/post/responses/200/content/application~1json/examples/SmartPix","paths/~1init-payment/post/responses/200/content/application~1json/examples/UPI","paths/~1init-payment/post/responses/200/content/application~1json/examples/Webpay","paths/~1init-payment/post/responses/200/content/application~1json/examples/WeChat Pay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1init-payment/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1init-payment/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1init-payment/post/responses/200/content/application~1json/examples/Error X.XX"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_192","exampleIds":["paths/~1init-payment/post/responses/200/content/application~1json/examples/PayPal","paths/~1init-payment/post/responses/200/content/application~1json/examples/Alipay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Blik","paths/~1init-payment/post/responses/200/content/application~1json/examples/Blik Pay Later","paths/~1init-payment/post/responses/200/content/application~1json/examples/Bizum","paths/~1init-payment/post/responses/200/content/application~1json/examples/Boleto","paths/~1init-payment/post/responses/200/content/application~1json/examples/Cash App Pay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Efecty","paths/~1init-payment/post/responses/200/content/application~1json/examples/GCash","paths/~1init-payment/post/responses/200/content/application~1json/examples/Ideal","paths/~1init-payment/post/responses/200/content/application~1json/examples/Klarna","paths/~1init-payment/post/responses/200/content/application~1json/examples/MB WAY","paths/~1init-payment/post/responses/200/content/application~1json/examples/Mercado Pago","paths/~1init-payment/post/responses/200/content/application~1json/examples/MobilePay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Multibanco","paths/~1init-payment/post/responses/200/content/application~1json/examples/OXXO","paths/~1init-payment/post/responses/200/content/application~1json/examples/Pay by Bank","paths/~1init-payment/post/responses/200/content/application~1json/examples/Pix QR","paths/~1init-payment/post/responses/200/content/application~1json/examples/Pix Automático","paths/~1init-payment/post/responses/200/content/application~1json/examples/Przelewy24","paths/~1init-payment/post/responses/200/content/application~1json/examples/PSE","paths/~1init-payment/post/responses/200/content/application~1json/examples/Sencillito","paths/~1init-payment/post/responses/200/content/application~1json/examples/Servipag","paths/~1init-payment/post/responses/200/content/application~1json/examples/SmartPix","paths/~1init-payment/post/responses/200/content/application~1json/examples/UPI","paths/~1init-payment/post/responses/200/content/application~1json/examples/Webpay","paths/~1init-payment/post/responses/200/content/application~1json/examples/WeChat Pay","paths/~1init-payment/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1init-payment/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1init-payment/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1init-payment/post/responses/200/content/application~1json/examples/Error X.XX"]}}}],"examples":[]}]}]}]},"httpPath":"/init-payment"},{"label":"Recurring","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/alternative-payment-methods/make-apm-recurring","routeSlug":"/api/alternative-payment-methods/make-apm-recurring","metadata":{"seo":{"title":"Recurring","description":"Initiate a token-based recurring payment refers to an automatic billing applied to a customer's payment method at predetermined intervals."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"make-apm-recurring","name":"Recurring","isWebhook":false,"pointer":"/paths/~1v1~1recurring/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recurring","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiate a token-based "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/#recurring","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment refers to an automatic billing applied to a customer's payment method at predetermined intervals."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This process involves securely storing a token representing the customer's payment details and using it for subsequent transactions without requiring input each time."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1v1~1recurring/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_193","exampleIds":["paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Klarna","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/WeChat Pay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay"]}},"schemaId":"schema_193","exampleIds":["paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Klarna","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/WeChat Pay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay"],"pointer":"/paths/~1v1~1recurring/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/recurring","servers":[{"url":"https://gate.solidgate.com/api","description":"APM payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_193","exampleIds":["paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Klarna","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/WeChat Pay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay"]}},"responseCodes":["200"],"pointer":"/v1/recurring","href":"alternative-payment-methods/make-apm-recurring","openApiOperationId":"make-apm-recurring","summary":"Recurring"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://gate.solidgate.com/api","description":"APM payments Live API"}],"schemaId":"schema_193","exampleIds":["paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Klarna","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/WeChat Pay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_193","exampleIds":["paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Klarna","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/WeChat Pay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment PayPal","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Alipay","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Blik","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment GCash","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment MB WAY","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment SmartPix","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment UPI","paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194","exampleIds":["paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error X.XX"]}},"schemaId":"schema_194","exampleIds":["paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error X.XX"]}],"pointer":"/paths/~1v1~1recurring/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_194","exampleIds":["paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error X.XX"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194","exampleIds":["paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error X.XX"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/recurring"},{"label":"Revoke token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/alternative-payment-methods/revoke-apm-recurring-token","routeSlug":"/api/alternative-payment-methods/revoke-apm-recurring-token","metadata":{"seo":{"title":"Revoke token","description":"Request to revoke a recurring token for alternative payment methods."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"revoke-apm-recurring-token","name":"Revoke token","isWebhook":false,"pointer":"/paths/~1v1~1recurring-token~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/#revoke-token","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revoke"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a recurring token for alternative payment methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Available for tokens initiated with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_method"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"alipay"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"mbway"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"wechatpay"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1v1~1recurring-token~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmRecurringTokenCancellation","exampleIds":["paths/~1v1~1recurring-token~1cancel/post/requestBody/content/application~1json/examples/Request"]}},"schemaId":"components/schemas/RequestApmRecurringTokenCancellation","exampleIds":["paths/~1v1~1recurring-token~1cancel/post/requestBody/content/application~1json/examples/Request"],"pointer":"/paths/~1v1~1recurring-token~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/recurring-token/cancel","servers":[{"url":"https://gate.solidgate.com/api","description":"APM payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestApmRecurringTokenCancellation","exampleIds":["paths/~1v1~1recurring-token~1cancel/post/requestBody/content/application~1json/examples/Request"]}},"responseCodes":["200"],"pointer":"/v1/recurring-token/cancel","href":"alternative-payment-methods/revoke-apm-recurring-token","openApiOperationId":"revoke-apm-recurring-token","summary":"Revoke token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://gate.solidgate.com/api","description":"APM payments Live API"}],"schemaId":"components/schemas/RequestApmRecurringTokenCancellation","exampleIds":["paths/~1v1~1recurring-token~1cancel/post/requestBody/content/application~1json/examples/Request"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmRecurringTokenCancellation","exampleIds":["paths/~1v1~1recurring-token~1cancel/post/requestBody/content/application~1json/examples/Request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_195","exampleIds":["paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 1.01 Authentication failed","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Token not found","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Unsupported method","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Token already cancelled","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation already processing","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation is already concurrently processing","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation failed"]}},"schemaId":"schema_195","exampleIds":["paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 1.01 Authentication failed","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Token not found","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Unsupported method","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Token already cancelled","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation already processing","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation is already concurrently processing","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation failed"]}],"pointer":"/paths/~1v1~1recurring-token~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_195","exampleIds":["paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 1.01 Authentication failed","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Token not found","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Unsupported method","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Token already cancelled","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation already processing","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation is already concurrently processing","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_195","exampleIds":["paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 1.01 Authentication failed","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Token not found","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Unsupported method","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Token already cancelled","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation already processing","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation is already concurrently processing","paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation failed"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/recurring-token/cancel"},{"label":"Refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/alternative-payment-methods/refund-apm-order","routeSlug":"/api/alternative-payment-methods/refund-apm-order","metadata":{"seo":{"title":"Refund","description":"Initiate a refund request to return funds for successfully processed orders."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refund-apm-order","name":"Refund","isWebhook":false,"pointer":"/paths/~1v1~1refund/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiate a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/#refund","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to return funds for successfully processed orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is important to note that, for instance, refunds might not be accessible or could be restricted when using alternative cash-based payment methods."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1v1~1refund/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmRefund","exampleIds":["paths/~1v1~1refund/post/requestBody/content/application~1json/examples/Refund"]}},"schemaId":"components/schemas/RequestApmRefund","exampleIds":["paths/~1v1~1refund/post/requestBody/content/application~1json/examples/Refund"],"pointer":"/paths/~1v1~1refund/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/refund","servers":[{"url":"https://gate.solidgate.com/api","description":"APM payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestApmRefund","exampleIds":["paths/~1v1~1refund/post/requestBody/content/application~1json/examples/Refund"]}},"responseCodes":["200"],"pointer":"/v1/refund","href":"alternative-payment-methods/refund-apm-order","openApiOperationId":"refund-apm-order","summary":"Refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://gate.solidgate.com/api","description":"APM payments Live API"}],"schemaId":"components/schemas/RequestApmRefund","exampleIds":["paths/~1v1~1refund/post/requestBody/content/application~1json/examples/Refund"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmRefund","exampleIds":["paths/~1v1~1refund/post/requestBody/content/application~1json/examples/Refund"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_196","exampleIds":["paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"]}},"schemaId":"schema_196","exampleIds":["paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"]}],"pointer":"/paths/~1v1~1refund/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_196","exampleIds":["paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_196","exampleIds":["paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/refund"},{"label":"Check order status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/alternative-payment-methods/get-status-apm-order","routeSlug":"/api/alternative-payment-methods/get-status-apm-order","metadata":{"seo":{"title":"Check order status","description":"Request for receiving current order status. The key benefit is that it allows merchants to efficiently monitor and manage their payments by providing comprehensive information about the order's status, payment method, transaction details, and customer information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-status-apm-order","name":"Check order status","isWebhook":false,"pointer":"/paths/~1v1~1status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check order status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request for receiving current order status. The key benefit is that it allows merchants to efficiently monitor and manage their payments by providing comprehensive information about the order's status, payment method, transaction details, and customer information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1v1~1status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmCheckOrderStatus"}},"schemaId":"components/schemas/RequestApmCheckOrderStatus","pointer":"/paths/~1v1~1status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/status","servers":[{"url":"https://gate.solidgate.com/api","description":"APM payments Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestApmCheckOrderStatus"}},"responseCodes":["200"],"pointer":"/v1/status","href":"alternative-payment-methods/get-status-apm-order","openApiOperationId":"get-status-apm-order","summary":"Check order status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://gate.solidgate.com/api","description":"APM payments Live API"}],"schemaId":"components/schemas/RequestApmCheckOrderStatus","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmCheckOrderStatus"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_197","exampleIds":["paths/~1v1~1status/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1status/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1v1~1status/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1v1~1status/post/responses/200/content/application~1json/examples/Error X.XX"]}},"schemaId":"schema_197","exampleIds":["paths/~1v1~1status/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1status/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1v1~1status/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1v1~1status/post/responses/200/content/application~1json/examples/Error X.XX"]}],"pointer":"/paths/~1v1~1status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_197","exampleIds":["paths/~1v1~1status/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1status/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1v1~1status/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1v1~1status/post/responses/200/content/application~1json/examples/Error X.XX"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_197","exampleIds":["paths/~1v1~1status/post/responses/200/content/application~1json/examples/Success","paths/~1v1~1status/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1v1~1status/post/responses/200/content/application~1json/examples/Error 2.01 Order not found","paths/~1v1~1status/post/responses/200/content/application~1json/examples/Error X.XX"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/status"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Updated alternative order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/alternative-payment-methods/webhook-apm-order-status","routeSlug":"/api/alternative-payment-methods/webhook-apm-order-status","metadata":{"seo":{"title":"Updated alternative order","description":"Webhooks for alternative payment method status enable merchants to securely receive real-time notifications of changes in the status of alternative payment methods, such as processing or declined, and automatically initiate actions or updates in their own systems based on those events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-apm-order-status","name":"Updated alternative order","isWebhook":true,"pointer":"/paths/APMOrderStatus/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updated alternative order","badges":[{"name":"Event","color":"purple"}],"isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for alternative payment method status enable merchants to securely receive real-time notifications of changes in the status of alternative payment methods, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and automatically initiate actions or updates in their own systems based on those events."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Duplicate webhook events can occur. Implement "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#event-handling","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"idempotency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" on your end to avoid processing the same event twice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_188","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true},{"name":"solidgate-event-id","in":"header","schemaId":"schema_189","description":"Unique event identifier.","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1"},{"name":"solidgate-event-created-at","in":"header","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event creation time in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with milliseconds."},"children":[]}]}]}],"required":true,"example":"2025-06-05T12:34:56.789Z"},{"name":"solidgate-event-type","in":"header","schemaId":"schema_189","description":"Event type, indicating the specific event that occurred.","required":true,"example":"alt_gate.order.updated"}],"pointer":"/paths/APMOrderStatus/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmWebhookOrderStatus","exampleIds":["paths/APMOrderStatus/post/requestBody/content/application~1json/examples/Updated alternative order"]}},"schemaId":"components/schemas/RequestApmWebhookOrderStatus","exampleIds":["paths/APMOrderStatus/post/requestBody/content/application~1json/examples/Updated alternative order"],"pointer":"/paths/APMOrderStatus/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"APMOrderStatus","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"wh_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchantWebhook"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"},{"name":"solidgate-event-id","in":"header","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1","schemaId":"schema_189"},{"name":"solidgate-event-created-at","in":"header","required":true,"example":"2025-06-05T12:34:56.789Z","schemaId":"schema_190"},{"name":"solidgate-event-type","in":"header","required":true,"example":"alt_gate.order.updated","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestApmWebhookOrderStatus","exampleIds":["paths/APMOrderStatus/post/requestBody/content/application~1json/examples/Updated alternative order"]}},"responseCodes":["2XX"],"pointer":"APMOrderStatus","href":"alternative-payment-methods/webhook-apm-order-status","openApiOperationId":"webhook-apm-order-status","summary":"Updated alternative order"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"schemaId":"components/schemas/RequestApmWebhookOrderStatus","exampleIds":["paths/APMOrderStatus/post/requestBody/content/application~1json/examples/Updated alternative order"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmWebhookOrderStatus","exampleIds":["paths/APMOrderStatus/post/requestBody/content/application~1json/examples/Updated alternative order"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Return any 2XX status to confirm successful data receipt"}],"pointer":"/paths/APMOrderStatus/post/responses"}],"panels":[]}]},"badges":[{"name":"Event","color":"purple"}],"httpPath":"APMOrderStatus"},{"label":"Received PayPal dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/alternative-payment-methods/webhook-paypal-dispute","routeSlug":"/api/alternative-payment-methods/webhook-paypal-dispute","metadata":{"seo":{"title":"Received PayPal dispute","description":"Webhooks delivers critical insights into each PayPal dispute and its lifecycle, enabling businesses to manage disputes effectively and enhance customer satisfaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-paypal-dispute","name":"Received PayPal dispute","isWebhook":true,"pointer":"/paths/PayPalDispute/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Received PayPal dispute","badges":[{"name":"Event","color":"purple"}],"isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" delivers critical insights into each "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dispute and its lifecycle, enabling businesses to manage disputes effectively and enhance customer satisfaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Duplicate webhook events can occur. Implement "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#event-handling","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"idempotency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" on your end to avoid processing the same event twice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_188","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true},{"name":"solidgate-event-id","in":"header","schemaId":"schema_189","description":"Unique event identifier.","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1"},{"name":"solidgate-event-created-at","in":"header","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event creation time in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with milliseconds."},"children":[]}]}]}],"required":true,"example":"2025-06-05T12:34:56.789Z"},{"name":"solidgate-event-type","in":"header","schemaId":"schema_189","description":"Event type, indicating the specific event that occurred.","required":true,"example":"alt_gate.paypal_dispute.received"}],"pointer":"/paths/PayPalDispute/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmWebhookPaypalDispute","exampleIds":["paths/PayPalDispute/post/requestBody/content/application~1json/examples/Received PayPal dispute"]}},"schemaId":"components/schemas/RequestApmWebhookPaypalDispute","exampleIds":["paths/PayPalDispute/post/requestBody/content/application~1json/examples/Received PayPal dispute"],"pointer":"/paths/PayPalDispute/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"PayPalDispute","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"wh_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchantWebhook"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"},{"name":"solidgate-event-id","in":"header","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1","schemaId":"schema_189"},{"name":"solidgate-event-created-at","in":"header","required":true,"example":"2025-06-05T12:34:56.789Z","schemaId":"schema_190"},{"name":"solidgate-event-type","in":"header","required":true,"example":"alt_gate.paypal_dispute.received","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestApmWebhookPaypalDispute","exampleIds":["paths/PayPalDispute/post/requestBody/content/application~1json/examples/Received PayPal dispute"]}},"responseCodes":["2XX"],"pointer":"PayPalDispute","href":"alternative-payment-methods/webhook-paypal-dispute","openApiOperationId":"webhook-paypal-dispute","summary":"Received PayPal dispute"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"schemaId":"components/schemas/RequestApmWebhookPaypalDispute","exampleIds":["paths/PayPalDispute/post/requestBody/content/application~1json/examples/Received PayPal dispute"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmWebhookPaypalDispute","exampleIds":["paths/PayPalDispute/post/requestBody/content/application~1json/examples/Received PayPal dispute"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Return any 2XX status to confirm successful data receipt"}],"pointer":"/paths/PayPalDispute/post/responses"}],"panels":[]}]},"badges":[{"name":"Event","color":"purple"}],"httpPath":"PayPalDispute"},{"label":"Received prevention alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/alternative-payment-methods/webhook-apm-alert-prevent","routeSlug":"/api/alternative-payment-methods/webhook-apm-alert-prevent","metadata":{"seo":{"title":"Received prevention alert","description":"Webhooks enable to preemptively identify and resolve potential issues, thereby preventing the generation of alert, specifically for the PayPal method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-apm-alert-prevent","name":"Received prevention alert","isWebhook":true,"pointer":"/paths/APMPreventAlert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Received prevention alert","badges":[{"name":"Event","color":"purple"}],"isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enable to preemptively identify and resolve potential issues, thereby preventing the generation of alert, specifically for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Duplicate webhook events can occur. Implement "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#event-handling","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"idempotency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" on your end to avoid processing the same event twice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_188","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true},{"name":"solidgate-event-id","in":"header","schemaId":"schema_189","description":"Unique event identifier.","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1"},{"name":"solidgate-event-created-at","in":"header","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event creation time in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with milliseconds."},"children":[]}]}]}],"required":true,"example":"2025-06-05T12:34:56.789Z"},{"name":"solidgate-event-type","in":"header","schemaId":"schema_189","description":"Event type, indicating the specific event that occurred.","required":true,"example":"card_gate.prevention_alert.received"}],"pointer":"/paths/APMPreventAlert/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmWebhookPreventAlert","exampleIds":["paths/APMPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert"]}},"schemaId":"components/schemas/RequestApmWebhookPreventAlert","exampleIds":["paths/APMPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert"],"pointer":"/paths/APMPreventAlert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"APMPreventAlert","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"wh_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchantWebhook"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"},{"name":"solidgate-event-id","in":"header","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1","schemaId":"schema_189"},{"name":"solidgate-event-created-at","in":"header","required":true,"example":"2025-06-05T12:34:56.789Z","schemaId":"schema_190"},{"name":"solidgate-event-type","in":"header","required":true,"example":"card_gate.prevention_alert.received","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestApmWebhookPreventAlert","exampleIds":["paths/APMPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert"]}},"responseCodes":["2XX"],"pointer":"APMPreventAlert","href":"alternative-payment-methods/webhook-apm-alert-prevent","openApiOperationId":"webhook-apm-alert-prevent","summary":"Received prevention alert"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"schemaId":"components/schemas/RequestApmWebhookPreventAlert","exampleIds":["paths/APMPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmWebhookPreventAlert","exampleIds":["paths/APMPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Return any 2XX status to confirm successful data receipt"}],"pointer":"/paths/APMPreventAlert/post/responses"}],"panels":[]}]},"badges":[{"name":"Event","color":"purple"}],"httpPath":"APMPreventAlert"},{"label":"Revoked recurring token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/alternative-payment-methods/webhook-apm-revoked-recurring-token","routeSlug":"/api/alternative-payment-methods/webhook-apm-revoked-recurring-token","metadata":{"seo":{"title":"Revoked recurring token","description":"Webhooks notify about a revoked recurring token for alternative payment methods."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-apm-revoked-recurring-token","name":"Revoked recurring token","isWebhook":true,"pointer":"/paths/APMRevokedRecurringToken/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoked recurring token","badges":[{"name":"Event","color":"purple"}],"isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notify about a revoked recurring token for alternative payment methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Duplicate webhook events can occur. Implement "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#event-handling","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"idempotency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" on your end to avoid processing the same event twice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_188","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true},{"name":"solidgate-event-id","in":"header","schemaId":"schema_189","description":"Unique event identifier.","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1"},{"name":"solidgate-event-created-at","in":"header","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event creation time in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with milliseconds."},"children":[]}]}]}],"required":true,"example":"2025-06-05T12:34:56.789Z"},{"name":"solidgate-event-type","in":"header","schemaId":"schema_189","description":"Event type, indicating the specific event that occurred.","required":true,"example":"alt_gate.recurring_token.cancelled"}],"pointer":"/paths/APMRevokedRecurringToken/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmWebhookRevokedRecurringToken","exampleIds":["paths/APMRevokedRecurringToken/post/requestBody/content/application~1json/examples/Revoked recurring token"]}},"schemaId":"components/schemas/RequestApmWebhookRevokedRecurringToken","exampleIds":["paths/APMRevokedRecurringToken/post/requestBody/content/application~1json/examples/Revoked recurring token"],"pointer":"/paths/APMRevokedRecurringToken/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"APMRevokedRecurringToken","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"wh_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchantWebhook"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"},{"name":"solidgate-event-id","in":"header","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1","schemaId":"schema_189"},{"name":"solidgate-event-created-at","in":"header","required":true,"example":"2025-06-05T12:34:56.789Z","schemaId":"schema_190"},{"name":"solidgate-event-type","in":"header","required":true,"example":"alt_gate.recurring_token.cancelled","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestApmWebhookRevokedRecurringToken","exampleIds":["paths/APMRevokedRecurringToken/post/requestBody/content/application~1json/examples/Revoked recurring token"]}},"responseCodes":["2XX"],"pointer":"APMRevokedRecurringToken","href":"alternative-payment-methods/webhook-apm-revoked-recurring-token","openApiOperationId":"webhook-apm-revoked-recurring-token","summary":"Revoked recurring token"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"schemaId":"components/schemas/RequestApmWebhookRevokedRecurringToken","exampleIds":["paths/APMRevokedRecurringToken/post/requestBody/content/application~1json/examples/Revoked recurring token"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestApmWebhookRevokedRecurringToken","exampleIds":["paths/APMRevokedRecurringToken/post/requestBody/content/application~1json/examples/Revoked recurring token"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Return any 2XX status to confirm successful data receipt"}],"pointer":"/paths/APMRevokedRecurringToken/post/responses"}],"panels":[]}]},"badges":[{"name":"Event","color":"purple"}],"httpPath":"APMRevokedRecurringToken"}],"content":{"contentType":"group","meta":{"name":"Alternative payment methods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alternative payment methods","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solidgate API for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows merchants to securely integrate with a payment gateway to process and manage APM transactions such as PayPal, Pay by Bank, etc."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/init-payment","summary":"Init payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alternative-payment-methods/create-apm-init-payment","deprecated":false},{"title":"/v1/recurring","summary":"Recurring","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alternative-payment-methods/make-apm-recurring","deprecated":false},{"title":"/v1/recurring-token/cancel","summary":"Revoke token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alternative-payment-methods/revoke-apm-recurring-token","deprecated":false},{"title":"/v1/refund","summary":"Refund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alternative-payment-methods/refund-apm-order","deprecated":false},{"title":"/v1/status","summary":"Check order status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alternative-payment-methods/get-status-apm-order","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"APMOrderStatus","summary":"Updated alternative order","prefix":{"name":"post","color":"post"},"badges":[{"name":"Event","color":"purple"}],"link":"/alternative-payment-methods/webhook-apm-order-status","deprecated":false},{"title":"PayPalDispute","summary":"Received PayPal dispute","prefix":{"name":"post","color":"post"},"badges":[{"name":"Event","color":"purple"}],"link":"/alternative-payment-methods/webhook-paypal-dispute","deprecated":false},{"title":"APMPreventAlert","summary":"Received prevention alert","prefix":{"name":"post","color":"post"},"badges":[{"name":"Event","color":"purple"}],"link":"/alternative-payment-methods/webhook-apm-alert-prevent","deprecated":false},{"title":"APMRevokedRecurringToken","summary":"Revoked recurring token","prefix":{"name":"post","color":"post"},"badges":[{"name":"Event","color":"purple"}],"link":"/alternative-payment-methods/webhook-apm-revoked-recurring-token","deprecated":false}]}]}]}]}},{"type":"separator","label":"Billing","content":null},{"type":"group","label":"Products and prices","link":"/api/products-and-prices","routeSlug":"/api/products-and-prices","items":[{"label":"Create product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/create-product","routeSlug":"/api/products-and-prices/create-product","metadata":{"seo":{"title":"Create product","description":"This method allows merchants to create new products by providing the required details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-product","name":"Create product","isWebhook":false,"pointer":"/paths/~1products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method allows merchants to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#create-product","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create new products"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by providing the required details."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Products created via API cannot be edited in the Solidgate Hub unless a default price is set. To add a default price and enable editing, use the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/products-and-prices/create-product-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"create product price"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1products/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_198","exampleIds":["paths/~1products/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1products/post/requestBody/content/application~1json/examples/Subscription payment"]}},"schemaId":"schema_198","exampleIds":["paths/~1products/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1products/post/requestBody/content/application~1json/examples/Subscription payment"],"pointer":"/paths/~1products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_198","exampleIds":["paths/~1products/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1products/post/requestBody/content/application~1json/examples/Subscription payment"]}},"responseCodes":["200","400","401","403","422"],"pointer":"/products","href":"products-and-prices/create-product","openApiOperationId":"create-product","summary":"Create product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"schema_198","exampleIds":["paths/~1products/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1products/post/requestBody/content/application~1json/examples/Subscription payment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_198","exampleIds":["paths/~1products/post/requestBody/content/application~1json/examples/Product-based payment","paths/~1products/post/requestBody/content/application~1json/examples/Subscription payment"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product has been created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_199","exampleIds":["paths/~1products/post/responses/200/content/application~1json/examples/Product-based payment","paths/~1products/post/responses/200/content/application~1json/examples/Subscription payment"]}},"schemaId":"schema_199","exampleIds":["paths/~1products/post/responses/200/content/application~1json/examples/Product-based payment","paths/~1products/post/responses/200/content/application~1json/examples/Subscription payment"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}},"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}],"pointer":"/paths/~1products/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_199","exampleIds":["paths/~1products/post/responses/200/content/application~1json/examples/Product-based payment","paths/~1products/post/responses/200/content/application~1json/examples/Subscription payment"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_199","exampleIds":["paths/~1products/post/responses/200/content/application~1json/examples/Product-based payment","paths/~1products/post/responses/200/content/application~1json/examples/Subscription payment"]}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"422","schemaId":"components/schemas/ResponseBillingUnprocessableEntityError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}}}],"examples":[]}]}]}]},"httpPath":"/products"},{"label":"Get product list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/get-products","routeSlug":"/api/products-and-prices/get-products","metadata":{"seo":{"title":"Get product list","description":"By using this method, merchants can find products and retrieve their details by applying filters such as product identifier, status, trial availability, and sorting criteria with pagination support."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-products","name":"Get product list","isWebhook":false,"pointer":"/paths/~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get product list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, merchants can find products and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#retrieve-product-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve their details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by applying filters such as product identifier, status, trial availability, and sorting criteria with pagination support."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[id]","in":"query","schemaId":"schema_200","description":"Specify the comma-separated ids of products."},{"name":"filter[status]","in":"query","schemaId":"schema_201"},{"name":"filter[has_trial]","in":"query","schemaId":"schema_202"},{"name":"pagination[limit]","in":"query","schemaId":"schema_203"},{"name":"pagination[offset]","in":"query","schemaId":"schema_204"}],"pointer":"/paths/~1products/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[{"name":"filter[id]","in":"query","example":"ac43b415-5522-4373-b026-a365462f9657,xx33b415-5522-4373-b026-a365462f9657","schemaId":"schema_200"},{"name":"filter[status]","in":"query","schemaId":"schema_201"},{"name":"filter[has_trial]","in":"query","schemaId":"schema_202"},{"name":"pagination[limit]","in":"query","example":10,"schemaId":"schema_203"},{"name":"pagination[offset]","in":"query","example":10,"schemaId":"schema_204"}],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/products","href":"products-and-prices/get-products","openApiOperationId":"get-products","summary":"Get product list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_205","exampleIds":["paths/~1products/get/responses/200/content/application~1json/examples/Product-based payment","paths/~1products/get/responses/200/content/application~1json/examples/Subscription payment"]}},"schemaId":"schema_205","exampleIds":["paths/~1products/get/responses/200/content/application~1json/examples/Product-based payment","paths/~1products/get/responses/200/content/application~1json/examples/Subscription payment"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"}],"pointer":"/paths/~1products/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_205","exampleIds":["paths/~1products/get/responses/200/content/application~1json/examples/Product-based payment","paths/~1products/get/responses/200/content/application~1json/examples/Subscription payment"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_205","exampleIds":["paths/~1products/get/responses/200/content/application~1json/examples/Product-based payment","paths/~1products/get/responses/200/content/application~1json/examples/Subscription payment"]}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}}],"examples":[]}]}]}]},"httpPath":"/products"},{"label":"Update product","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/update-product","routeSlug":"/api/products-and-prices/update-product","metadata":{"seo":{"title":"Update product","description":"This method updates the existing product with specified details and returns the updated product information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-product","name":"Update product","isWebhook":false,"pointer":"/paths/~1products~1{product_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#edit-product","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updates the existing product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with specified details and returns the updated product information."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Recurring products can only be updated when all associated subscriptions are in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"expired"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status. Products without subscriptions can be updated without restrictions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product_id","in":"path","schemaId":"schema_206","required":true}],"pointer":"/paths/~1products~1{product_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1products~1{product_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_207","exampleIds":["paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Subscription payment"]}},"schemaId":"schema_207","exampleIds":["paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Subscription payment"],"pointer":"/paths/~1products~1{product_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/products/{product_id}","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[{"name":"product_id","in":"path","required":true,"example":"ac43b415-5522-4373-b026-a365462f9657","schemaId":"schema_206"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_207","exampleIds":["paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Subscription payment"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/products/{product_id}","href":"products-and-prices/update-product","openApiOperationId":"update-product","summary":"Update product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"schema_207","exampleIds":["paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Subscription payment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_207","exampleIds":["paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Subscription payment"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product has been updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_208","exampleIds":["paths/~1products~1{product_id}/patch/responses/200/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}/patch/responses/200/content/application~1json/examples/Subscription payment"]}},"schemaId":"schema_208","exampleIds":["paths/~1products~1{product_id}/patch/responses/200/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}/patch/responses/200/content/application~1json/examples/Subscription payment"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}},"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}],"pointer":"/paths/~1products~1{product_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_208","exampleIds":["paths/~1products~1{product_id}/patch/responses/200/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}/patch/responses/200/content/application~1json/examples/Subscription payment"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_208","exampleIds":["paths/~1products~1{product_id}/patch/responses/200/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}/patch/responses/200/content/application~1json/examples/Subscription payment"]}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}},{"code":"422","schemaId":"components/schemas/ResponseBillingUnprocessableEntityError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}}}],"examples":[]}]}]}]},"httpPath":"/products/{product_id}"},{"label":"Get product by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/get-product-by-id","routeSlug":"/api/products-and-prices/get-product-by-id","metadata":{"seo":{"title":"Get product by ID","description":"This method allows merchants to obtain the existing product by its identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-product-by-id","name":"Get product by ID","isWebhook":false,"pointer":"/paths/~1products~1{product_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get product by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method allows merchants to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#retrieve-product-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"obtain the existing product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by its identifier."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product_id","in":"path","schemaId":"schema_209","required":true}],"pointer":"/paths/~1products~1{product_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1products~1{product_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products/{product_id}","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[{"name":"product_id","in":"path","required":true,"example":"ac43b415-5522-4373-b026-a365462f9657","schemaId":"schema_209"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/products/{product_id}","href":"products-and-prices/get-product-by-id","openApiOperationId":"get-product-by-id","summary":"Get product by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_210","exampleIds":["paths/~1products~1{product_id}/get/responses/200/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}/get/responses/200/content/application~1json/examples/Subscription payment"]}},"schemaId":"schema_210","exampleIds":["paths/~1products~1{product_id}/get/responses/200/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}/get/responses/200/content/application~1json/examples/Subscription payment"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"}],"pointer":"/paths/~1products~1{product_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_210","exampleIds":["paths/~1products~1{product_id}/get/responses/200/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}/get/responses/200/content/application~1json/examples/Subscription payment"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_210","exampleIds":["paths/~1products~1{product_id}/get/responses/200/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}/get/responses/200/content/application~1json/examples/Subscription payment"]}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}}],"examples":[]}]}]}]},"httpPath":"/products/{product_id}"},{"label":"Archive product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/archive-product","routeSlug":"/api/products-and-prices/archive-product","metadata":{"seo":{"title":"Archive product","description":"By using this method, merchants can archive products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archive-product","name":"Archive product","isWebhook":false,"pointer":"/paths/~1products~1{product_id}~1archive/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, merchants can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#archive-product","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"archive products"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Note that the archived product cannot be restored or added to new subscriptions. Existing subscriptions with the archived product remain active until cancelled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product_id","in":"path","schemaId":"schema_206","required":true}],"pointer":"/paths/~1products~1{product_id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1products~1{product_id}~1archive/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products/{product_id}/archive","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[{"name":"product_id","in":"path","required":true,"example":"ac43b415-5522-4373-b026-a365462f9657","schemaId":"schema_206"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422"],"pointer":"/products/{product_id}/archive","href":"products-and-prices/archive-product","openApiOperationId":"archive-product","summary":"Archive product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product has been archived","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_211","exampleIds":["paths/~1products~1{product_id}~1archive/post/responses/200/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}~1archive/post/responses/200/content/application~1json/examples/Subscription payment"]}},"schemaId":"schema_211","exampleIds":["paths/~1products~1{product_id}~1archive/post/responses/200/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}~1archive/post/responses/200/content/application~1json/examples/Subscription payment"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}},"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}],"pointer":"/paths/~1products~1{product_id}~1archive/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_211","exampleIds":["paths/~1products~1{product_id}~1archive/post/responses/200/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}~1archive/post/responses/200/content/application~1json/examples/Subscription payment"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_211","exampleIds":["paths/~1products~1{product_id}~1archive/post/responses/200/content/application~1json/examples/Product-based payment","paths/~1products~1{product_id}~1archive/post/responses/200/content/application~1json/examples/Subscription payment"]}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}},{"code":"422","schemaId":"components/schemas/ResponseBillingUnprocessableEntityError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}}}],"examples":[]}]}]}]},"httpPath":"/products/{product_id}/archive"},{"label":"Create product price","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/create-product-price","routeSlug":"/api/products-and-prices/create-product-price","metadata":{"seo":{"title":"Create product price","description":"By using this method, merchants can create a new product price with specified details and retrieve the created product price information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-product-price","name":"Create product price","isWebhook":false,"pointer":"/paths/~1products~1{product_id}~1prices/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create product price","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, merchants can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#create-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create a new product price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with specified details and retrieve the created product price information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product_id","in":"path","schemaId":"schema_206","required":true}],"pointer":"/paths/~1products~1{product_id}~1prices/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1products~1{product_id}~1prices/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingProductPriceCreate"}},"schemaId":"components/schemas/RequestBillingProductPriceCreate","pointer":"/paths/~1products~1{product_id}~1prices/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products/{product_id}/prices","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[{"name":"product_id","in":"path","required":true,"example":"ac43b415-5522-4373-b026-a365462f9657","schemaId":"schema_206"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingProductPriceCreate"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/products/{product_id}/prices","href":"products-and-prices/create-product-price","openApiOperationId":"create-product-price","summary":"Create product price"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingProductPriceCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingProductPriceCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product price has been created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingProductPriceCreate"}},"schemaId":"components/schemas/ResponseBillingProductPriceCreate"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}},"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}],"pointer":"/paths/~1products~1{product_id}~1prices/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseBillingProductPriceCreate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingProductPriceCreate"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}},{"code":"422","schemaId":"components/schemas/ResponseBillingUnprocessableEntityError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}}}],"examples":[]}]}]}]},"httpPath":"/products/{product_id}/prices"},{"label":"Get product prices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/get-product-prices","routeSlug":"/api/products-and-prices/get-product-prices","metadata":{"seo":{"title":"Get product prices","description":"This method allows merchants to retrieve product prices based on the specified filter criteria and pagination settings, returning the results along with pagination information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-product-prices","name":"Get product prices","isWebhook":false,"pointer":"/paths/~1products~1{product_id}~1prices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get product prices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method allows merchants to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#retrieve-price-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve product prices"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" based on the specified filter criteria and pagination settings, returning the results along with pagination information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product_id","in":"path","schemaId":"schema_206","required":true}],"pointer":"/paths/~1products~1{product_id}~1prices/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[currency]","in":"query","schemaId":"schema_212","description":"Specify the comma-separated currencies."},{"name":"filter[country]","in":"query","schemaId":"schema_213"},{"name":"pagination[limit]","in":"query","schemaId":"schema_203"},{"name":"pagination[offset]","in":"query","schemaId":"schema_204"}],"pointer":"/paths/~1products~1{product_id}~1prices/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_189","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/access-to-api/#retrieve-your-credentials","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided upon registration and must be shared for identification purposes."},"children":[]}]}]}],"required":true,"example":"api_pk_7b197...ba108f842"},{"name":"signature","in":"header","schemaId":"schema_189","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/access-to-api/#generate-signature","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of request. It allows verifying whether the request from the merchant is genuine on the payment gateway server."},"children":[]}]}]}],"required":true,"example":"M2E3OTkyNzcz...xMmExODI4"}],"pointer":"/paths/~1products~1{product_id}~1prices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products/{product_id}/prices","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[{"name":"product_id","in":"path","required":true,"example":"ac43b415-5522-4373-b026-a365462f9657","schemaId":"schema_206"}],"query":[{"name":"filter[currency]","in":"query","example":"EUR, USD","schemaId":"schema_212"},{"name":"filter[country]","in":"query","example":"USA","schemaId":"schema_213"},{"name":"pagination[limit]","in":"query","example":10,"schemaId":"schema_203"},{"name":"pagination[offset]","in":"query","example":10,"schemaId":"schema_204"}],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"schema_189"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/products/{product_id}/prices","href":"products-and-prices/get-product-prices","openApiOperationId":"get-product-prices","summary":"Get product prices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product price data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingProductPriceCreateList"}},"schemaId":"components/schemas/ResponseBillingProductPriceCreateList"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"}],"pointer":"/paths/~1products~1{product_id}~1prices/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseBillingProductPriceCreateList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingProductPriceCreateList"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}}],"examples":[]}]}]}]},"httpPath":"/products/{product_id}/prices"},{"label":"Retrieve prices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/find-prices","routeSlug":"/api/products-and-prices/find-prices","metadata":{"seo":{"title":"Retrieve prices","description":"This method allows merchants to retrieve prices in bulk based on specified filter criteria with pagination settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"find-prices","name":"Retrieve prices","isWebhook":false,"pointer":"/paths/~1products~1prices~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve prices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method allows merchants to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#retrieve-price-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve prices"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in bulk based on specified filter criteria with pagination settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Without filters, the request returns all prices in the merchant account."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"With filters, each filter field requires a value to avoid validation errors."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_189","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/access-to-api/#retrieve-your-credentials","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided upon registration and must be shared for identification purposes."},"children":[]}]}]}],"required":true,"example":"api_pk_7b197...ba108f842"},{"name":"signature","in":"header","schemaId":"schema_189","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/access-to-api/#generate-signature","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of request. It allows verifying whether the request from the merchant is genuine on the payment gateway server."},"children":[]}]}]}],"required":true,"example":"M2E3OTkyNzcz...xMmExODI4"}],"pointer":"/paths/~1products~1prices~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingRetrievePrices"}},"schemaId":"components/schemas/RequestBillingRetrievePrices","pointer":"/paths/~1products~1prices~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products/prices/list","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"schema_189"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingRetrievePrices"}},"responseCodes":["200","400","401","403"],"pointer":"/products/prices/list","href":"products-and-prices/find-prices","openApiOperationId":"find-prices","summary":"Retrieve prices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingRetrievePrices","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingRetrievePrices"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Prices data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingRetrievePrices"}},"schemaId":"components/schemas/ResponseBillingRetrievePrices"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"}],"pointer":"/paths/~1products~1prices~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseBillingRetrievePrices","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingRetrievePrices"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}}],"examples":[]}]}]}]},"httpPath":"/products/prices/list"},{"label":"Update product price","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/update-product-price","routeSlug":"/api/products-and-prices/update-product-price","metadata":{"seo":{"title":"Update product price","description":"By using this method, you can update an existing product price."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-product-price","name":"Update product price","isWebhook":false,"pointer":"/paths/~1products~1{product_id}~1prices~1{product_price_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update product price","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, you can update an existing "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#edit-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"You can update a price only when all associated subscriptions are in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"expired"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status. If the price has no associated subscriptions, you can update it without restrictions."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This restriction does not apply when you only promote a price to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"default"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Promoting a price to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"default"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only changes which price is used as default. This works regardless of subscription status. If you also update "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_price"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"trial_price"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the restriction still applies."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product_id","in":"path","schemaId":"schema_206","required":true},{"name":"product_price_id","in":"path","schemaId":"schema_214","required":true}],"pointer":"/paths/~1products~1{product_id}~1prices~1{product_price_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1products~1{product_id}~1prices~1{product_price_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingProductPriceUpdate"}},"schemaId":"components/schemas/RequestBillingProductPriceUpdate","pointer":"/paths/~1products~1{product_id}~1prices~1{product_price_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/products/{product_id}/prices/{product_price_id}","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[{"name":"product_id","in":"path","required":true,"example":"ac43b415-5522-4373-b026-a365462f9657","schemaId":"schema_206"},{"name":"product_price_id","in":"path","required":true,"example":"fa43b415-5522-4373-b026-a365562f9649","schemaId":"schema_214"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingProductPriceUpdate"}},"responseCodes":["200","400","401","403","404"],"pointer":"/products/{product_id}/prices/{product_price_id}","href":"products-and-prices/update-product-price","openApiOperationId":"update-product-price","summary":"Update product price"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingProductPriceUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingProductPriceUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product price has been updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingProductPriceCreate"}},"schemaId":"components/schemas/ResponseBillingProductPriceCreate"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"}],"pointer":"/paths/~1products~1{product_id}~1prices~1{product_price_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseBillingProductPriceCreate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingProductPriceCreate"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}}],"examples":[]}]}]}]},"httpPath":"/products/{product_id}/prices/{product_price_id}"},{"label":"Archive product price","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/archive-product-price","routeSlug":"/api/products-and-prices/archive-product-price","metadata":{"seo":{"title":"Archive product price","description":"By using this method, you can archive an existing product price."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archive-product-price","name":"Archive product price","isWebhook":false,"pointer":"/paths/~1products~1{product_id}~1prices~1{product_price_id}~1archive/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive product price","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, you can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#edit-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"archive an existing product price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Only non-default prices that are not already archived can be archived."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"To archive the current default price, first promote a different price to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"default"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" using the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/products-and-prices/update-product-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"update product price"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" operation. Promotion only removes the default status from the previous default price, but it stays active. Archive it with a separate call to this operation once it is no longer the default."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product_id","in":"path","schemaId":"schema_206","required":true},{"name":"product_price_id","in":"path","schemaId":"schema_214","required":true}],"pointer":"/paths/~1products~1{product_id}~1prices~1{product_price_id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1products~1{product_id}~1prices~1{product_price_id}~1archive/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products/{product_id}/prices/{product_price_id}/archive","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[{"name":"product_id","in":"path","required":true,"example":"ac43b415-5522-4373-b026-a365462f9657","schemaId":"schema_206"},{"name":"product_price_id","in":"path","required":true,"example":"fa43b415-5522-4373-b026-a365562f9649","schemaId":"schema_214"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422"],"pointer":"/products/{product_id}/prices/{product_price_id}/archive","href":"products-and-prices/archive-product-price","openApiOperationId":"archive-product-price","summary":"Archive product price"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product price has been archived","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingProductPriceArchive"}},"schemaId":"components/schemas/ResponseBillingProductPriceArchive"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}},"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}],"pointer":"/paths/~1products~1{product_id}~1prices~1{product_price_id}~1archive/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseBillingProductPriceArchive","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingProductPriceArchive"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}},{"code":"422","schemaId":"components/schemas/ResponseBillingUnprocessableEntityError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}}}],"examples":[]}]}]}]},"httpPath":"/products/{product_id}/prices/{product_price_id}/archive"},{"label":"Calculate product price","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/calculate-product-price","routeSlug":"/api/products-and-prices/calculate-product-price","metadata":{"seo":{"title":"Calculate product price","description":"This method allows merchants to calculate an estimated product price for a specific location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"calculate-product-price","name":"Calculate product price","isWebhook":false,"pointer":"/paths/~1products~1calculatePrice/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Calculate product price","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method allows merchants to calculate an estimated product price for a specific location."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Calculated prices returned by this endpoint are estimates. The final charged amount may differ at the time of billing due to product updates, tax changes, or other configuration changes."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1products~1calculatePrice/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingProductPriceCalculate"}},"schemaId":"components/schemas/RequestBillingProductPriceCalculate","pointer":"/paths/~1products~1calculatePrice/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products/calculatePrice","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingProductPriceCalculate"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/products/calculatePrice","href":"products-and-prices/calculate-product-price","openApiOperationId":"calculate-product-price","summary":"Calculate product price"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingProductPriceCalculate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingProductPriceCalculate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Result of price calculation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingProductPriceCalculate","exampleIds":["paths/~1products~1calculatePrice/post/responses/200/content/application~1json/examples/Success"]}},"schemaId":"components/schemas/ResponseBillingProductPriceCalculate","exampleIds":["paths/~1products~1calculatePrice/post/responses/200/content/application~1json/examples/Success"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}},"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}],"pointer":"/paths/~1products~1calculatePrice/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseBillingProductPriceCalculate","exampleIds":["paths/~1products~1calculatePrice/post/responses/200/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingProductPriceCalculate","exampleIds":["paths/~1products~1calculatePrice/post/responses/200/content/application~1json/examples/Success"]}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}},{"code":"422","schemaId":"components/schemas/ResponseBillingUnprocessableEntityError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}}}],"examples":[]}]}]}]},"httpPath":"/products/calculatePrice"}],"content":{"contentType":"group","meta":{"name":"Products and prices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products and prices","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solidgate API for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" management allows merchants to create and update products and pricing effectively, ensuring businesses can adapt to diverse customer needs and preferences."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/products","summary":"Create product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products-and-prices/create-product","deprecated":false},{"title":"/products","summary":"Get product list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products-and-prices/get-products","deprecated":false},{"title":"/products/{product_id}","summary":"Update product","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/products-and-prices/update-product","deprecated":false},{"title":"/products/{product_id}","summary":"Get product by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products-and-prices/get-product-by-id","deprecated":false},{"title":"/products/{product_id}/archive","summary":"Archive product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products-and-prices/archive-product","deprecated":false},{"title":"/products/{product_id}/prices","summary":"Create product price","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products-and-prices/create-product-price","deprecated":false},{"title":"/products/{product_id}/prices","summary":"Get product prices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products-and-prices/get-product-prices","deprecated":false},{"title":"/products/prices/list","summary":"Retrieve prices","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products-and-prices/find-prices","deprecated":false},{"title":"/products/{product_id}/prices/{product_price_id}","summary":"Update product price","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/products-and-prices/update-product-price","deprecated":false},{"title":"/products/{product_id}/prices/{product_price_id}/archive","summary":"Archive product price","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products-and-prices/archive-product-price","deprecated":false},{"title":"/products/calculatePrice","summary":"Calculate product price","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products-and-prices/calculate-product-price","deprecated":false}]}]}]}]}},{"type":"group","label":"Taxes","link":"/api/taxes","routeSlug":"/api/taxes","items":[{"label":"Transactional tax","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/taxes/tax-transactional","routeSlug":"/api/taxes/tax-transactional","metadata":{"seo":{"title":"Transactional tax","description":"The transactional tax report aggregates every tax-relevant transaction into one file, combining order and product identifiers, channel and legal entity, processing amounts and currency, full tax breakdown, include type, rate, taxable and tax amounts, location, and BIN/IP geography for delivering a concise, high-level view of liabilities across entities and jurisdictions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tax-transactional","name":"Transactional tax","isWebhook":false,"pointer":"/paths/~1transactional/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactional tax","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#tax-reports","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactional tax report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" aggregates every tax-relevant transaction into one file, combining order and product identifiers, channel and legal entity, processing amounts and currency, full tax breakdown, include type, rate, taxable and tax amounts, location, and BIN/IP geography for delivering a concise, high-level view of liabilities across entities and jurisdictions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In a successful response, you receive a link to the file "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The tax data are in a CSV file, which can be found at the link."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1transactional/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_215"}},"schemaId":"schema_215","pointer":"/paths/~1transactional/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactional","servers":[{"url":"https://reports.solidgate.com/api/v1/tax","description":"Reports Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_215"}},"responseCodes":["200"],"pointer":"/transactional","href":"taxes/tax-transactional","openApiOperationId":"tax-transactional","summary":"Transactional tax"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1/tax","description":"Reports Live API"}],"schemaId":"schema_215","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_215"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_216","exampleIds":["paths/~1transactional/post/responses/200/content/application~1json/examples/Success","paths/~1transactional/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_216","exampleIds":["paths/~1transactional/post/responses/200/content/application~1json/examples/Success","paths/~1transactional/post/responses/200/content/application~1json/examples/Authentication failed"]}],"pointer":"/paths/~1transactional/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_216","exampleIds":["paths/~1transactional/post/responses/200/content/application~1json/examples/Success","paths/~1transactional/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_216","exampleIds":["paths/~1transactional/post/responses/200/content/application~1json/examples/Success","paths/~1transactional/post/responses/200/content/application~1json/examples/Authentication failed"]}}}],"examples":[]}]}]}]},"httpPath":"/transactional"},{"label":"Download transactional tax","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/taxes/download-tax-transactional","routeSlug":"/api/taxes/download-tax-transactional","metadata":{"seo":{"title":"Download transactional tax","description":"Retrieves a ready-generated transactional tax report CSV."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download-tax-transactional","name":"Download transactional tax","isWebhook":false,"pointer":"/paths/~1transactional~1report~1{report_id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download transactional tax","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a ready-generated "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#tax-reports","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactional tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" report CSV."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Send the request and, if the file exists, you get a short-lived pre-signed S3 URL that immediately starts the download."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_217","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique report identifier for download."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It follows the pattern [report_prefix] [date (yyMMdd)] [time (HHmmss)] [channel name]."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1transactional~1report~1{report_id}~1download/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1transactional~1report~1{report_id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactional/report/{report_id}/download","servers":[{"url":"https://reports.solidgate.com/api/v1/tax","description":"Reports Live API"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"example":"TAX_250702_140728_CHECKOUT","schemaId":"schema_217"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200","204","302","404","410"],"pointer":"/transactional/report/{report_id}/download","href":"taxes/download-tax-transactional","openApiOperationId":"download-tax-transactional","summary":"Download transactional tax"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1/tax","description":"Reports Live API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request received"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #1d8126","marginLeft":"20px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{"style":{"color":"#1d8126","marginLeft":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Response either redirects to S3 for download or returns error object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_216","exampleIds":["paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]}},"schemaId":"schema_216","exampleIds":["paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]},{"code":"204","description":"Report is not ready"},{"code":"302","description":"Redirect to one-time S3 download report link"},{"code":"404","description":"Report not found"},{"code":"410","description":"Report unavailable (expired)"}],"pointer":"/paths/~1transactional~1report~1{report_id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_216","exampleIds":["paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_216","exampleIds":["paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]}}},{"code":"204"},{"code":"302"},{"code":"404"},{"code":"410"}],"examples":[]}]}]}]},"httpPath":"/transactional/report/{report_id}/download"},{"label":"Summary tax","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/taxes/tax-summary","routeSlug":"/api/taxes/tax-summary","metadata":{"seo":{"title":"Summary tax","description":"The summary tax report aggregates your tax data into a single file, grouping figures by every unique combination of legal entity, tax location, and processing currency configured in your Solidgate account. It includes key metrics such as taxable turnover, calculated tax amount, and net revenue for each group, giving you a clear, high-level view of your liabilities across jurisdictions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tax-summary","name":"Summary tax","isWebhook":false,"pointer":"/paths/~1summary/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Summary tax","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#tax-reports","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"summary tax report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" aggregates your tax data into a single file, grouping figures by every unique combination of legal entity, tax location, and processing currency configured in your Solidgate account. It includes key metrics such as taxable turnover, calculated tax amount, and net revenue for each group, giving you a clear, high-level view of your liabilities across jurisdictions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In a successful response, you receive a link to the file "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The tax data are in a CSV file, which can be found at the link."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1summary/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_218"}},"schemaId":"schema_218","pointer":"/paths/~1summary/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/summary","servers":[{"url":"https://reports.solidgate.com/api/v1/tax","description":"Reports Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_218"}},"responseCodes":["200"],"pointer":"/summary","href":"taxes/tax-summary","openApiOperationId":"tax-summary","summary":"Summary tax"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1/tax","description":"Reports Live API"}],"schemaId":"schema_218","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_218"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_219","exampleIds":["paths/~1summary/post/responses/200/content/application~1json/examples/Success","paths/~1summary/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_219","exampleIds":["paths/~1summary/post/responses/200/content/application~1json/examples/Success","paths/~1summary/post/responses/200/content/application~1json/examples/Authentication failed"]}],"pointer":"/paths/~1summary/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_219","exampleIds":["paths/~1summary/post/responses/200/content/application~1json/examples/Success","paths/~1summary/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_219","exampleIds":["paths/~1summary/post/responses/200/content/application~1json/examples/Success","paths/~1summary/post/responses/200/content/application~1json/examples/Authentication failed"]}}}],"examples":[]}]}]}]},"httpPath":"/summary"},{"label":"Download summary tax","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/taxes/download-tax-summary","routeSlug":"/api/taxes/download-tax-summary","metadata":{"seo":{"title":"Download summary tax","description":"Retrieves a ready-generated summary tax report CSV."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download-tax-summary","name":"Download summary tax","isWebhook":false,"pointer":"/paths/~1summary~1report~1{report_id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download summary tax","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a ready-generated "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#tax-reports","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"summary tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" report CSV."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Send the request and, if the file exists, you get a short-lived pre-signed S3 URL that immediately starts the download."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_217","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique report identifier for download."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It follows the pattern [report_prefix] [date (yyMMdd)] [time (HHmmss)] [channel name]."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1summary~1report~1{report_id}~1download/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1summary~1report~1{report_id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/summary/report/{report_id}/download","servers":[{"url":"https://reports.solidgate.com/api/v1/tax","description":"Reports Live API"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"example":"TAX_250702_140728_CHECKOUT","schemaId":"schema_217"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200","204","302","404","410"],"pointer":"/summary/report/{report_id}/download","href":"taxes/download-tax-summary","openApiOperationId":"download-tax-summary","summary":"Download summary tax"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1/tax","description":"Reports Live API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request received"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #1d8126","marginLeft":"20px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{"style":{"color":"#1d8126","marginLeft":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Response either redirects to S3 for download or returns error object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_219","exampleIds":["paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]}},"schemaId":"schema_219","exampleIds":["paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]},{"code":"204","description":"Report is not ready"},{"code":"302","description":"Redirect to one-time S3 download report link"},{"code":"404","description":"Report not found"},{"code":"410","description":"Report unavailable (expired)"}],"pointer":"/paths/~1summary~1report~1{report_id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_219","exampleIds":["paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_219","exampleIds":["paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]}}},{"code":"204"},{"code":"302"},{"code":"404"},{"code":"410"}],"examples":[]}]}]}]},"httpPath":"/summary/report/{report_id}/download"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Calculated tax","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/taxes/webhook-calculated-tax","routeSlug":"/api/taxes/webhook-calculated-tax","metadata":{"seo":{"title":"Calculated tax","description":"Webhooks provide merchants with instant notifications when the Solidgate tax solution calculates the tax amount of the transaction. These notifications allow merchants to notify users about paid taxes or to save tax information in real-time on the merchant’s side."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-calculated-tax","name":"Calculated tax","isWebhook":true,"pointer":"/paths/CalculatedTax/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Calculated tax","badges":[{"name":"Event","color":"purple"}],"isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provide merchants with instant notifications when the Solidgate tax solution calculates the tax amount of the transaction. These notifications allow merchants to notify users about paid taxes or to save tax information in real-time on the merchant’s side."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It delivers key tax details, such as calculated amounts and tax type breakdowns, ensuring accurate and automated tax application for transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Duplicate webhook events can occur. Implement "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#event-handling","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"idempotency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" on your end to avoid processing the same event twice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_188","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true},{"name":"solidgate-event-id","in":"header","schemaId":"schema_189","description":"Unique event identifier.","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1"},{"name":"solidgate-event-created-at","in":"header","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event creation time in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with milliseconds."},"children":[]}]}]}],"required":true,"example":"2025-06-05T12:34:56.789Z"},{"name":"solidgate-event-type","in":"header","schemaId":"schema_189","description":"Event type, indicating the specific event that occurred.","required":true,"example":"taxer.tax.calculated"}],"pointer":"/paths/CalculatedTax/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingWebhookTaxCalculated","exampleIds":["paths/CalculatedTax/post/requestBody/content/application~1json/examples/Calculated tax"]}},"schemaId":"components/schemas/RequestBillingWebhookTaxCalculated","exampleIds":["paths/CalculatedTax/post/requestBody/content/application~1json/examples/Calculated tax"],"pointer":"/paths/CalculatedTax/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"CalculatedTax","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"wh_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchantWebhook"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"},{"name":"solidgate-event-id","in":"header","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1","schemaId":"schema_189"},{"name":"solidgate-event-created-at","in":"header","required":true,"example":"2025-06-05T12:34:56.789Z","schemaId":"schema_190"},{"name":"solidgate-event-type","in":"header","required":true,"example":"taxer.tax.calculated","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingWebhookTaxCalculated","exampleIds":["paths/CalculatedTax/post/requestBody/content/application~1json/examples/Calculated tax"]}},"responseCodes":["2XX"],"pointer":"CalculatedTax","href":"taxes/webhook-calculated-tax","openApiOperationId":"webhook-calculated-tax","summary":"Calculated tax"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"schemaId":"components/schemas/RequestBillingWebhookTaxCalculated","exampleIds":["paths/CalculatedTax/post/requestBody/content/application~1json/examples/Calculated tax"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingWebhookTaxCalculated","exampleIds":["paths/CalculatedTax/post/requestBody/content/application~1json/examples/Calculated tax"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Return any 2XX status to confirm successful data receipt"}],"pointer":"/paths/CalculatedTax/post/responses"}],"panels":[]}]},"badges":[{"name":"Event","color":"purple"}],"httpPath":"CalculatedTax"}],"content":{"contentType":"group","meta":{"name":"Taxes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Taxes","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solidgate’s "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax solution"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" empowers businesses to manage and automate tax calculations across multiple regions efficiently. By integrating the tax solution, merchants can support accurate tax handling and compliance with local regulations."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transactional","summary":"Transactional tax","prefix":{"name":"post","color":"post"},"badges":[],"link":"/taxes/tax-transactional","deprecated":false},{"title":"/transactional/report/{report_id}/download","summary":"Download transactional tax","prefix":{"name":"get","color":"get"},"badges":[],"link":"/taxes/download-tax-transactional","deprecated":false},{"title":"/summary","summary":"Summary tax","prefix":{"name":"post","color":"post"},"badges":[],"link":"/taxes/tax-summary","deprecated":false},{"title":"/summary/report/{report_id}/download","summary":"Download summary tax","prefix":{"name":"get","color":"get"},"badges":[],"link":"/taxes/download-tax-summary","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"CalculatedTax","summary":"Calculated tax","prefix":{"name":"post","color":"post"},"badges":[{"name":"Event","color":"purple"}],"link":"/taxes/webhook-calculated-tax","deprecated":false}]}]}]}]}},{"type":"group","label":"Manage subscriptions","link":"/api/manage-subscriptions","routeSlug":"/api/manage-subscriptions","items":[{"label":"Update subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/update-subscription","routeSlug":"/api/manage-subscriptions/update-subscription","metadata":{"seo":{"title":"Update subscription","description":"By using this method, merchants can update an active subscription by modifying the trial period, applying a discount, or changing the product. It allows multiple changes in a single request for efficient subscription management and customer retention."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-subscription","name":"Update subscription","isWebhook":false,"pointer":"/paths/~1subscription~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, merchants can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/update-subscription/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" an active subscription by modifying the trial period, applying a discount, or changing the product. It allows multiple changes in a single request for efficient subscription management and customer retention."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscription~1update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionUpdate"}},"schemaId":"components/schemas/RequestBillingSubscriptionUpdate","pointer":"/paths/~1subscription~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription/update","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionUpdate"}},"responseCodes":["200","400","401","403","422"],"pointer":"/subscription/update","href":"manage-subscriptions/update-subscription","openApiOperationId":"update-subscription","summary":"Update subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingSubscriptionUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription has been updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingSubscriptionUpdate"}},"schemaId":"components/schemas/ResponseBillingSubscriptionUpdate"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}},"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}],"pointer":"/paths/~1subscription~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseBillingSubscriptionUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingSubscriptionUpdate"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"422","schemaId":"components/schemas/ResponseBillingUnprocessableEntityError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}}}],"examples":[]}]}]}]},"httpPath":"/subscription/update"},{"label":"Switch product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/switch-subscription-product","routeSlug":"/api/manage-subscriptions/switch-subscription-product","metadata":{"seo":{"title":"Switch product","description":"By using this method, merchants can update the product in the active subscription with a new one. After the switch request is made, a callback confirms the update and includes the new subscription product. The updated settings take effect on the next billing date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"switch-subscription-product","name":"Switch product","isWebhook":false,"pointer":"/paths/~1subscription~1switch-subscription-product/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Switch product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, merchants can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/switch-subscription-product/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update the product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the active subscription with a new one. After the switch request is made, a callback confirms the update and includes the new subscription product. The updated settings take effect on the next billing date."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The switch is subject to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/switch-subscription-product/#product-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"conditions"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" related to currency and location compatibility between the current and new products."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscription~1switch-subscription-product/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionProductSwitch"}},"schemaId":"components/schemas/RequestBillingSubscriptionProductSwitch","pointer":"/paths/~1subscription~1switch-subscription-product/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription/switch-subscription-product","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionProductSwitch"}},"responseCodes":["200","400","401","403","404"],"pointer":"/subscription/switch-subscription-product","href":"manage-subscriptions/switch-subscription-product","openApiOperationId":"switch-subscription-product","summary":"Switch product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingSubscriptionProductSwitch","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionProductSwitch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_220"}},"schemaId":"schema_220"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"}],"pointer":"/paths/~1subscription~1switch-subscription-product/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_220","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_220"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}}],"examples":[]}]}]}]},"httpPath":"/subscription/switch-subscription-product"},{"label":"Update subscription token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/update-subscription-token","routeSlug":"/api/manage-subscriptions/update-subscription-token","metadata":{"seo":{"title":"Update subscription token","description":"This method provides a mechanism for merchants to update the payment token when the customer's preferred payment method changes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-subscription-token","name":"Update subscription token","isWebhook":false,"pointer":"/paths/~1subscription~1update-token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update subscription token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method provides a mechanism for merchants to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/update-subscription-token/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update the payment token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the customer's preferred payment method changes."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscription~1update-token/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionUpdateToken"}},"schemaId":"components/schemas/RequestBillingSubscriptionUpdateToken","pointer":"/paths/~1subscription~1update-token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription/update-token","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionUpdateToken"}},"responseCodes":["200","400","401","403","404"],"pointer":"/subscription/update-token","href":"manage-subscriptions/update-subscription-token","openApiOperationId":"update-subscription-token","summary":"Update subscription token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingSubscriptionUpdateToken","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionUpdateToken"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription token has been updated"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound","exampleIds":["paths/~1subscription~1update-token/post/responses/404/content/application~1json/examples/Entity not found"]}},"schemaId":"components/schemas/ResponseBillingEntityNotFound","exampleIds":["paths/~1subscription~1update-token/post/responses/404/content/application~1json/examples/Entity not found"]}],"pointer":"/paths/~1subscription~1update-token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","exampleIds":["paths/~1subscription~1update-token/post/responses/404/content/application~1json/examples/Entity not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound","exampleIds":["paths/~1subscription~1update-token/post/responses/404/content/application~1json/examples/Entity not found"]}}}],"examples":[]}]}]}]},"httpPath":"/subscription/update-token"},{"label":"Create subscription pause","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/create-subscription-pause","routeSlug":"/api/manage-subscriptions/create-subscription-pause","metadata":{"seo":{"title":"Create subscription pause","description":"By using this method, merchants can schedule a subscription pause, setting the specific start and end dates for the pause period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-subscription-pause","name":"Create subscription pause","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create subscription pause","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, merchants can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/pause-subscription/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"schedule a subscription pause"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", setting the specific start and end dates for the pause period."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_221","description":"Unique subscription identifier.","required":true,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionPauseCreate"}},"schemaId":"components/schemas/RequestBillingSubscriptionPauseCreate","pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{subscription_id}/pause-schedule","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e","schemaId":"schema_221"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionPauseCreate"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/subscriptions/{subscription_id}/pause-schedule","href":"manage-subscriptions/create-subscription-pause","openApiOperationId":"create-subscription-pause","summary":"Create subscription pause"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingSubscriptionPauseCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionPauseCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pause schedule has been created for subscription","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingSubscriptionPauseCreateUpdate"}},"schemaId":"components/schemas/ResponseBillingSubscriptionPauseCreateUpdate"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}},"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseBillingSubscriptionPauseCreateUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingSubscriptionPauseCreateUpdate"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}},{"code":"422","schemaId":"components/schemas/ResponseBillingUnprocessableEntityError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}}}],"examples":[]}]}]}]},"httpPath":"/subscriptions/{subscription_id}/pause-schedule"},{"label":"Update subscription pause","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/update-subscription-pause","routeSlug":"/api/manage-subscriptions/update-subscription-pause","metadata":{"seo":{"title":"Update subscription pause","description":"By using this method, merchants can modify the existing pause schedule, including the possibility of adjusting the start and end dates of the pause period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-subscription-pause","name":"Update subscription pause","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update subscription pause","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, merchants can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/pause-subscription/#manage-subscription-pause","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"modify"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the existing pause schedule, including the possibility of adjusting the start and end dates of the pause period."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Note that if the subscription pause is active, only its end date can be updated, while an inactive pause allows for updates to both start and end dates."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_221","description":"Unique subscription identifier.","required":true,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionPauseUpdate"}},"schemaId":"components/schemas/RequestBillingSubscriptionPauseUpdate","pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/subscriptions/{subscription_id}/pause-schedule","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e","schemaId":"schema_221"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionPauseUpdate"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/subscriptions/{subscription_id}/pause-schedule","href":"manage-subscriptions/update-subscription-pause","openApiOperationId":"update-subscription-pause","summary":"Update subscription pause"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingSubscriptionPauseUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionPauseUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pause schedule has been changed for subscription","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingSubscriptionPauseCreateUpdate"}},"schemaId":"components/schemas/ResponseBillingSubscriptionPauseCreateUpdate"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}},"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseBillingSubscriptionPauseCreateUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingSubscriptionPauseCreateUpdate"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}},{"code":"422","schemaId":"components/schemas/ResponseBillingUnprocessableEntityError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}}}],"examples":[]}]}]}]},"httpPath":"/subscriptions/{subscription_id}/pause-schedule"},{"label":"Remove subscription pause","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/delete-subscription-pause","routeSlug":"/api/manage-subscriptions/delete-subscription-pause","metadata":{"seo":{"title":"Remove subscription pause","description":"This method provides a way to delete the scheduled pause, reverting the subscription to its previous active state or as specified."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-subscription-pause","name":"Remove subscription pause","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove subscription pause","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method provides a way to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/pause-subscription/#resume-a-subscription","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delete the scheduled pause"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", reverting the subscription to its previous active state or as specified."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_221","description":"Unique subscription identifier.","required":true,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscriptions/{subscription_id}/pause-schedule","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e","schemaId":"schema_221"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422"],"pointer":"/subscriptions/{subscription_id}/pause-schedule","href":"manage-subscriptions/delete-subscription-pause","openApiOperationId":"delete-subscription-pause","summary":"Remove subscription pause"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pause schedule has been removed for subscription","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingSubscriptionPauseRemove"}},"schemaId":"components/schemas/ResponseBillingSubscriptionPauseRemove"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}},"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1pause-schedule/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseBillingSubscriptionPauseRemove","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingSubscriptionPauseRemove"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}},{"code":"422","schemaId":"components/schemas/ResponseBillingUnprocessableEntityError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnprocessableEntityError"}}}],"examples":[]}]}]}]},"httpPath":"/subscriptions/{subscription_id}/pause-schedule"},{"label":"Cancel subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/cancel-subscription","routeSlug":"/api/manage-subscriptions/cancel-subscription","metadata":{"seo":{"title":"Cancel subscription","description":"By using this method, merchants can cancel the specific subscription by its subscription identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel-subscription","name":"Cancel subscription","isWebhook":false,"pointer":"/paths/~1subscription~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, merchants can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/cancel-subscription/#by-subscription-id","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancel"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specific subscription by its subscription identifier."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscription~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionCancel"}},"schemaId":"components/schemas/RequestBillingSubscriptionCancel","pointer":"/paths/~1subscription~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription/cancel","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionCancel"}},"responseCodes":["200","400","401","403","404"],"pointer":"/subscription/cancel","href":"manage-subscriptions/cancel-subscription","openApiOperationId":"cancel-subscription","summary":"Cancel subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingSubscriptionCancel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionCancel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_222"}},"schemaId":"schema_222"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"}],"pointer":"/paths/~1subscription~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_222","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_222"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}}],"examples":[]}]}]}]},"httpPath":"/subscription/cancel"},{"label":"Cancel subscriptions by customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/cancel-subscriptions-by-customer","routeSlug":"/api/manage-subscriptions/cancel-subscriptions-by-customer","metadata":{"seo":{"title":"Cancel subscriptions by customer","description":"By using this method, the merchant can cancel all subscriptions for the specific customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel-subscriptions-by-customer","name":"Cancel subscriptions by customer","isWebhook":false,"pointer":"/paths/~1subscription~1cancel-by-customer/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel subscriptions by customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, the merchant can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/cancel-subscription/#by-customer-id","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancel"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" all subscriptions for the specific customer."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscription~1cancel-by-customer/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionCancelCustomer"}},"schemaId":"components/schemas/RequestBillingSubscriptionCancelCustomer","pointer":"/paths/~1subscription~1cancel-by-customer/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription/cancel-by-customer","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionCancelCustomer"}},"responseCodes":["200","400","401","403","404"],"pointer":"/subscription/cancel-by-customer","href":"manage-subscriptions/cancel-subscriptions-by-customer","openApiOperationId":"cancel-subscriptions-by-customer","summary":"Cancel subscriptions by customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingSubscriptionCancelCustomer","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionCancelCustomer"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_223"}},"schemaId":"schema_223"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"}],"pointer":"/paths/~1subscription~1cancel-by-customer/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_223","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_223"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}}],"examples":[]}]}]}]},"httpPath":"/subscription/cancel-by-customer"},{"label":"Restore subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/restore-subscription","routeSlug":"/api/manage-subscriptions/restore-subscription","metadata":{"seo":{"title":"Restore subscription","description":"By using this method, merchants can restore the specific subscription of their customer in case it was cancelled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"restore-subscription","name":"Restore subscription","isWebhook":false,"pointer":"/paths/~1subscription~1restore/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restore subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, merchants can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/restore-subscription/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"restore"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specific subscription of their customer in case it was cancelled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscription~1restore/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionRestore"}},"schemaId":"components/schemas/RequestBillingSubscriptionRestore","pointer":"/paths/~1subscription~1restore/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription/restore","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionRestore"}},"responseCodes":["200","400","401","403","404"],"pointer":"/subscription/restore","href":"manage-subscriptions/restore-subscription","openApiOperationId":"restore-subscription","summary":"Restore subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingSubscriptionRestore","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionRestore"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224"}},"schemaId":"schema_224"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"}],"pointer":"/paths/~1subscription~1restore/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_224","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}}],"examples":[]}]}]}]},"httpPath":"/subscription/restore"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Subscription payment updates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/manage-subscriptions/webhook-subscription-status","routeSlug":"/api/manage-subscriptions/webhook-subscription-status","metadata":{"seo":{"title":"Subscription payment updates","description":"Webhooks for subscription status provide real-time notifications about changes in subscription status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-subscription-status","name":"Subscription payment updates","isWebhook":true,"pointer":"/paths/Billing/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription payment updates","badges":[{"name":"Event","color":"purple"}],"isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-events/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for subscription status provide real-time notifications about changes in subscription status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook structure is similar to the subscription status method but additionally includes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callback_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter in the response object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two versions of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-events/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": legacy and extended."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The extended version offers an enhanced webhook event set with more detail and context, giving merchants deeper insights into subscription stages for better management and analysis."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The legacy version remains supported until the end of August 2026."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Duplicate webhook events can occur. Implement "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#event-handling","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"idempotency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" on your end to avoid processing the same event twice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameters for each callback type can vary based on factors such as product type, payment method, trial availability, or other specific conditions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_188","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true},{"name":"solidgate-event-id","in":"header","schemaId":"schema_189","description":"Unique event identifier.","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1"},{"name":"solidgate-event-created-at","in":"header","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event creation time in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with milliseconds."},"children":[]}]}]}],"required":true,"example":"2025-06-05T12:34:56.789Z"},{"name":"solidgate-event-type","in":"header","schemaId":"schema_189","description":"Event type, indicating the specific event that occurred.","required":true,"example":"subscription.updated.v2"}],"pointer":"/paths/Billing/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/Billing/post/requestBody/content/application~1json/examples/extended create","paths/Billing/post/requestBody/content/application~1json/examples/extended expire","paths/Billing/post/requestBody/content/application~1json/examples/extended payment_attempt","paths/Billing/post/requestBody/content/application~1json/examples/extended active","paths/Billing/post/requestBody/content/application~1json/examples/extended renew","paths/Billing/post/requestBody/content/application~1json/examples/extended switch_product","paths/Billing/post/requestBody/content/application~1json/examples/extended order_update","paths/Billing/post/requestBody/content/application~1json/examples/extended pause","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.create","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.update","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.delete","paths/Billing/post/requestBody/content/application~1json/examples/extended resume","paths/Billing/post/requestBody/content/application~1json/examples/extended recurring","paths/Billing/post/requestBody/content/application~1json/examples/extended restore","paths/Billing/post/requestBody/content/application~1json/examples/extended cancel","paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_cancellation","paths/Billing/post/requestBody/content/application~1json/examples/extended redemption","paths/Billing/post/requestBody/content/application~1json/examples/extended retry","paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_retry","paths/Billing/post/requestBody/content/application~1json/examples/init","paths/Billing/post/requestBody/content/application~1json/examples/renew","paths/Billing/post/requestBody/content/application~1json/examples/update","paths/Billing/post/requestBody/content/application~1json/examples/cancel","paths/Billing/post/requestBody/content/application~1json/examples/pause","paths/Billing/post/requestBody/content/application~1json/examples/resume","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.create","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.update","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.delete"]}},"schemaId":"schema_225","exampleIds":["paths/Billing/post/requestBody/content/application~1json/examples/extended create","paths/Billing/post/requestBody/content/application~1json/examples/extended expire","paths/Billing/post/requestBody/content/application~1json/examples/extended payment_attempt","paths/Billing/post/requestBody/content/application~1json/examples/extended active","paths/Billing/post/requestBody/content/application~1json/examples/extended renew","paths/Billing/post/requestBody/content/application~1json/examples/extended switch_product","paths/Billing/post/requestBody/content/application~1json/examples/extended order_update","paths/Billing/post/requestBody/content/application~1json/examples/extended pause","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.create","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.update","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.delete","paths/Billing/post/requestBody/content/application~1json/examples/extended resume","paths/Billing/post/requestBody/content/application~1json/examples/extended recurring","paths/Billing/post/requestBody/content/application~1json/examples/extended restore","paths/Billing/post/requestBody/content/application~1json/examples/extended cancel","paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_cancellation","paths/Billing/post/requestBody/content/application~1json/examples/extended redemption","paths/Billing/post/requestBody/content/application~1json/examples/extended retry","paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_retry","paths/Billing/post/requestBody/content/application~1json/examples/init","paths/Billing/post/requestBody/content/application~1json/examples/renew","paths/Billing/post/requestBody/content/application~1json/examples/update","paths/Billing/post/requestBody/content/application~1json/examples/cancel","paths/Billing/post/requestBody/content/application~1json/examples/pause","paths/Billing/post/requestBody/content/application~1json/examples/resume","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.create","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.update","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.delete"],"pointer":"/paths/Billing/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Billing","servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"wh_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchantWebhook"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"},{"name":"solidgate-event-id","in":"header","required":true,"example":"e1765cf7-70f7-4e56-8fb2-bd88744a94d1","schemaId":"schema_189"},{"name":"solidgate-event-created-at","in":"header","required":true,"example":"2025-06-05T12:34:56.789Z","schemaId":"schema_190"},{"name":"solidgate-event-type","in":"header","required":true,"example":"subscription.updated.v2","schemaId":"schema_189"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/Billing/post/requestBody/content/application~1json/examples/extended create","paths/Billing/post/requestBody/content/application~1json/examples/extended expire","paths/Billing/post/requestBody/content/application~1json/examples/extended payment_attempt","paths/Billing/post/requestBody/content/application~1json/examples/extended active","paths/Billing/post/requestBody/content/application~1json/examples/extended renew","paths/Billing/post/requestBody/content/application~1json/examples/extended switch_product","paths/Billing/post/requestBody/content/application~1json/examples/extended order_update","paths/Billing/post/requestBody/content/application~1json/examples/extended pause","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.create","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.update","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.delete","paths/Billing/post/requestBody/content/application~1json/examples/extended resume","paths/Billing/post/requestBody/content/application~1json/examples/extended recurring","paths/Billing/post/requestBody/content/application~1json/examples/extended restore","paths/Billing/post/requestBody/content/application~1json/examples/extended cancel","paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_cancellation","paths/Billing/post/requestBody/content/application~1json/examples/extended redemption","paths/Billing/post/requestBody/content/application~1json/examples/extended retry","paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_retry","paths/Billing/post/requestBody/content/application~1json/examples/init","paths/Billing/post/requestBody/content/application~1json/examples/renew","paths/Billing/post/requestBody/content/application~1json/examples/update","paths/Billing/post/requestBody/content/application~1json/examples/cancel","paths/Billing/post/requestBody/content/application~1json/examples/pause","paths/Billing/post/requestBody/content/application~1json/examples/resume","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.create","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.update","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.delete"]}},"responseCodes":["2XX"],"pointer":"Billing","href":"manage-subscriptions/webhook-subscription-status","openApiOperationId":"webhook-subscription-status","summary":"Subscription payment updates"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"schemaId":"schema_225","exampleIds":["paths/Billing/post/requestBody/content/application~1json/examples/extended create","paths/Billing/post/requestBody/content/application~1json/examples/extended expire","paths/Billing/post/requestBody/content/application~1json/examples/extended payment_attempt","paths/Billing/post/requestBody/content/application~1json/examples/extended active","paths/Billing/post/requestBody/content/application~1json/examples/extended renew","paths/Billing/post/requestBody/content/application~1json/examples/extended switch_product","paths/Billing/post/requestBody/content/application~1json/examples/extended order_update","paths/Billing/post/requestBody/content/application~1json/examples/extended pause","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.create","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.update","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.delete","paths/Billing/post/requestBody/content/application~1json/examples/extended resume","paths/Billing/post/requestBody/content/application~1json/examples/extended recurring","paths/Billing/post/requestBody/content/application~1json/examples/extended restore","paths/Billing/post/requestBody/content/application~1json/examples/extended cancel","paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_cancellation","paths/Billing/post/requestBody/content/application~1json/examples/extended redemption","paths/Billing/post/requestBody/content/application~1json/examples/extended retry","paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_retry","paths/Billing/post/requestBody/content/application~1json/examples/init","paths/Billing/post/requestBody/content/application~1json/examples/renew","paths/Billing/post/requestBody/content/application~1json/examples/update","paths/Billing/post/requestBody/content/application~1json/examples/cancel","paths/Billing/post/requestBody/content/application~1json/examples/pause","paths/Billing/post/requestBody/content/application~1json/examples/resume","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.create","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.update","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.delete"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/Billing/post/requestBody/content/application~1json/examples/extended create","paths/Billing/post/requestBody/content/application~1json/examples/extended expire","paths/Billing/post/requestBody/content/application~1json/examples/extended payment_attempt","paths/Billing/post/requestBody/content/application~1json/examples/extended active","paths/Billing/post/requestBody/content/application~1json/examples/extended renew","paths/Billing/post/requestBody/content/application~1json/examples/extended switch_product","paths/Billing/post/requestBody/content/application~1json/examples/extended order_update","paths/Billing/post/requestBody/content/application~1json/examples/extended pause","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.create","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.update","paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.delete","paths/Billing/post/requestBody/content/application~1json/examples/extended resume","paths/Billing/post/requestBody/content/application~1json/examples/extended recurring","paths/Billing/post/requestBody/content/application~1json/examples/extended restore","paths/Billing/post/requestBody/content/application~1json/examples/extended cancel","paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_cancellation","paths/Billing/post/requestBody/content/application~1json/examples/extended redemption","paths/Billing/post/requestBody/content/application~1json/examples/extended retry","paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_retry","paths/Billing/post/requestBody/content/application~1json/examples/init","paths/Billing/post/requestBody/content/application~1json/examples/renew","paths/Billing/post/requestBody/content/application~1json/examples/update","paths/Billing/post/requestBody/content/application~1json/examples/cancel","paths/Billing/post/requestBody/content/application~1json/examples/pause","paths/Billing/post/requestBody/content/application~1json/examples/resume","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.create","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.update","paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.delete"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Return any 2XX status to confirm successful data receipt"}],"pointer":"/paths/Billing/post/responses"}],"panels":[]}]},"badges":[{"name":"Event","color":"purple"}],"httpPath":"Billing"}],"content":{"contentType":"group","meta":{"name":"Manage subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manage subscriptions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solidgate API for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" empowers merchants in efficiently and securely managing subscriptions for a positive customer experience and business growth."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchants can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"easily handle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" their subscriptions using the available methods such as switching subscription products, pausing and resuming services, cancelling subscriptions, and providing customers with the option to update payment information."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscription/update","summary":"Update subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-subscriptions/update-subscription","deprecated":false},{"title":"/subscription/switch-subscription-product","summary":"Switch product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-subscriptions/switch-subscription-product","deprecated":false},{"title":"/subscription/update-token","summary":"Update subscription token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-subscriptions/update-subscription-token","deprecated":false},{"title":"/subscriptions/{subscription_id}/pause-schedule","summary":"Create subscription pause","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-subscriptions/create-subscription-pause","deprecated":false},{"title":"/subscriptions/{subscription_id}/pause-schedule","summary":"Update subscription pause","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/manage-subscriptions/update-subscription-pause","deprecated":false},{"title":"/subscriptions/{subscription_id}/pause-schedule","summary":"Remove subscription pause","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/manage-subscriptions/delete-subscription-pause","deprecated":false},{"title":"/subscription/cancel","summary":"Cancel subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-subscriptions/cancel-subscription","deprecated":false},{"title":"/subscription/cancel-by-customer","summary":"Cancel subscriptions by customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-subscriptions/cancel-subscriptions-by-customer","deprecated":false},{"title":"/subscription/restore","summary":"Restore subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-subscriptions/restore-subscription","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Billing","summary":"Subscription payment updates","prefix":{"name":"post","color":"post"},"badges":[{"name":"Event","color":"purple"}],"link":"/manage-subscriptions/webhook-subscription-status","deprecated":false}]}]}]}]}},{"type":"group","label":"Retrieve subscription data","link":"/api/retrieve-subscription-data","routeSlug":"/api/retrieve-subscription-data","items":[{"label":"Get subscription status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/retrieve-subscription-data/get-subscription-status","routeSlug":"/api/retrieve-subscription-data/get-subscription-status","metadata":{"seo":{"title":"Get subscription status","description":"By using this method, merchants can retrieve subscription data by subscription identifier and obtain its details, such as the start date, status, and the information about the most recent invoice related to the subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-subscription-status","name":"Get subscription status","isWebhook":false,"pointer":"/paths/~1subscription~1status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get subscription status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, merchants can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/retrieve-subscription-data/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve subscription data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by subscription identifier and obtain its details, such as the start date, status, and the information about the most recent invoice related to the subscription."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscription~1status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionStatus"}},"schemaId":"components/schemas/RequestBillingSubscriptionStatus","pointer":"/paths/~1subscription~1status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription/status","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionStatus"}},"responseCodes":["200","400","401","403","404"],"pointer":"/subscription/status","href":"retrieve-subscription-data/get-subscription-status","openApiOperationId":"get-subscription-status","summary":"Get subscription status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingSubscriptionStatus","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionStatus"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_226"}},"schemaId":"schema_226"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"}],"pointer":"/paths/~1subscription~1status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_226","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_226"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}}],"examples":[]}]}]}]},"httpPath":"/subscription/status"},{"label":"Retrieve subscriptions by customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/retrieve-subscription-data/retrieve-subscriptions-by-customer","routeSlug":"/api/retrieve-subscription-data/retrieve-subscriptions-by-customer","metadata":{"seo":{"title":"Retrieve subscriptions by customer","description":"This method allows the merchant to retrieve all subscriptions and their statuses for the specific customer by the customer identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-subscriptions-by-customer","name":"Retrieve subscriptions by customer","isWebhook":false,"pointer":"/paths/~1subscription~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve subscriptions by customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method allows the merchant to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/retrieve-subscription-data/#by-customer-id","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve all subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and their statuses for the specific customer by the customer identifier."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscription~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionRetrieveCustomer"}},"schemaId":"components/schemas/RequestBillingSubscriptionRetrieveCustomer","pointer":"/paths/~1subscription~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription/list","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionRetrieveCustomer"}},"responseCodes":["200","400","401","403","404"],"pointer":"/subscription/list","href":"retrieve-subscription-data/retrieve-subscriptions-by-customer","openApiOperationId":"retrieve-subscriptions-by-customer","summary":"Retrieve subscriptions by customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingSubscriptionRetrieveCustomer","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionRetrieveCustomer"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_227"}},"schemaId":"schema_227"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"}],"pointer":"/paths/~1subscription~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_227","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_227"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}}],"examples":[]}]}]}]},"httpPath":"/subscription/list"},{"label":"List invoices by subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/retrieve-subscription-data/list-invoices-by-subscription-id","routeSlug":"/api/retrieve-subscription-data/list-invoices-by-subscription-id","metadata":{"seo":{"title":"List invoices by subscription","description":"By using this method, merchants can get a list of invoices related to a specific subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-invoices-by-subscription-id","name":"List invoices by subscription","isWebhook":false,"pointer":"/paths/~1subscription~1invoice~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List invoices by subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, merchants can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/retrieve-subscription-data/#list-invoices-by-subscription-id","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"get a list of invoices"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" related to a specific subscription."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscription~1invoice~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionInvoiceListBySubscriptionID"}},"schemaId":"components/schemas/RequestBillingSubscriptionInvoiceListBySubscriptionID","pointer":"/paths/~1subscription~1invoice~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription/invoice/list","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionInvoiceListBySubscriptionID"}},"responseCodes":["200","400","401","403","404"],"pointer":"/subscription/invoice/list","href":"retrieve-subscription-data/list-invoices-by-subscription-id","openApiOperationId":"list-invoices-by-subscription-id","summary":"List invoices by subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingSubscriptionInvoiceListBySubscriptionID","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionInvoiceListBySubscriptionID"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of invoices","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingSubscriptionInvoiceListBySubscriptionID"}},"schemaId":"components/schemas/ResponseBillingSubscriptionInvoiceListBySubscriptionID"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"}],"pointer":"/paths/~1subscription~1invoice~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseBillingSubscriptionInvoiceListBySubscriptionID","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingSubscriptionInvoiceListBySubscriptionID"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}}],"examples":[]}]}]}]},"httpPath":"/subscription/invoice/list"},{"label":"List orders by invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/retrieve-subscription-data/list-orders-by-invoice-id","routeSlug":"/api/retrieve-subscription-data/list-orders-by-invoice-id","metadata":{"seo":{"title":"List orders by invoice","description":"By using this method, merchants can retrieve a list of orders associated with a particular invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-orders-by-invoice-id","name":"List orders by invoice","isWebhook":false,"pointer":"/paths/~1subscription~1order~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders by invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this method, merchants can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/retrieve-subscription-data/#list-orders-by-invoice-id","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve a list of orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with a particular invoice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscription~1order~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionOrderListByInvoiceID"}},"schemaId":"components/schemas/RequestBillingSubscriptionOrderListByInvoiceID","pointer":"/paths/~1subscription~1order~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription/order/list","servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionOrderListByInvoiceID"}},"responseCodes":["200","400","401","403","404"],"pointer":"/subscription/order/list","href":"retrieve-subscription-data/list-orders-by-invoice-id","openApiOperationId":"list-orders-by-invoice-id","summary":"List orders by invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions Live API"}],"schemaId":"components/schemas/RequestBillingSubscriptionOrderListByInvoiceID","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBillingSubscriptionOrderListByInvoiceID"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of subscription orders","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingSubscriptionOrderListByInvoiceID"}},"schemaId":"components/schemas/ResponseBillingSubscriptionOrderListByInvoiceID"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}},"schemaId":"components/schemas/ResponseBillingBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}},"schemaId":"components/schemas/ResponseBillingUnauthorized"},{"code":"403","description":"Access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}},"schemaId":"components/schemas/ResponseMainAccessDenied"},{"code":"404","description":"Entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}},"schemaId":"components/schemas/ResponseBillingEntityNotFound"}],"pointer":"/paths/~1subscription~1order~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseBillingSubscriptionOrderListByInvoiceID","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingSubscriptionOrderListByInvoiceID"}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest"}}},{"code":"401","schemaId":"components/schemas/ResponseBillingUnauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingUnauthorized"}}},{"code":"403","schemaId":"components/schemas/ResponseMainAccessDenied","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAccessDenied"}}},{"code":"404","schemaId":"components/schemas/ResponseBillingEntityNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingEntityNotFound"}}}],"examples":[]}]}]}]},"httpPath":"/subscription/order/list"}],"content":{"contentType":"group","meta":{"name":"Retrieve subscription data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve subscription data","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solidgate API for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/retrieve-subscription-data/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accessing subscription information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides merchants with the ability to obtain precise and up-to-date details regarding customer subscriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get in-depth insights into customer subscriptions, use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/reports/retrieve-subscriptions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is specifically designed to retrieve and combine all subscription-related data."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscription/status","summary":"Get subscription status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/retrieve-subscription-data/get-subscription-status","deprecated":false},{"title":"/subscription/list","summary":"Retrieve subscriptions by customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/retrieve-subscription-data/retrieve-subscriptions-by-customer","deprecated":false},{"title":"/subscription/invoice/list","summary":"List invoices by subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/retrieve-subscription-data/list-invoices-by-subscription-id","deprecated":false},{"title":"/subscription/order/list","summary":"List orders by invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/retrieve-subscription-data/list-orders-by-invoice-id","deprecated":false}]}]}]}]}},{"type":"separator","label":"Risks","content":null},{"type":"group","label":"Fraud prevention","link":"/api/fraud-prevention","routeSlug":"/api/fraud-prevention","items":[{"label":"Create fraud prevention list items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fraud-prevention/fraud-prevention-list-items-create","routeSlug":"/api/fraud-prevention/fraud-prevention-list-items-create","metadata":{"seo":{"title":"Create fraud prevention list items","description":"This method allows you to add new items to fraud prevention list linked to the merchant's account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fraud-prevention-list-items-create","name":"Create fraud prevention list items","isWebhook":false,"pointer":"/paths/~1fraud-prevention-list-items~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create fraud prevention list items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method allows you to add new items to fraud prevention list linked to the merchant's account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1fraud-prevention-list-items~1create/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestRisksFraudPreventionListItemsCreate","exampleIds":["paths/~1fraud-prevention-list-items~1create/post/requestBody/content/application~1json/examples/Batch"]}},"schemaId":"components/schemas/RequestRisksFraudPreventionListItemsCreate","exampleIds":["paths/~1fraud-prevention-list-items~1create/post/requestBody/content/application~1json/examples/Batch"],"pointer":"/paths/~1fraud-prevention-list-items~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fraud-prevention-list-items/create","servers":[{"url":"https://risks.solidgate.com/api/v1","description":"Risks management API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestRisksFraudPreventionListItemsCreate","exampleIds":["paths/~1fraud-prevention-list-items~1create/post/requestBody/content/application~1json/examples/Batch"]}},"responseCodes":["200"],"pointer":"/fraud-prevention-list-items/create","href":"fraud-prevention/fraud-prevention-list-items-create","openApiOperationId":"fraud-prevention-list-items-create","summary":"Create fraud prevention list items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://risks.solidgate.com/api/v1","description":"Risks management API"}],"schemaId":"components/schemas/RequestRisksFraudPreventionListItemsCreate","exampleIds":["paths/~1fraud-prevention-list-items~1create/post/requestBody/content/application~1json/examples/Batch"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestRisksFraudPreventionListItemsCreate","exampleIds":["paths/~1fraud-prevention-list-items~1create/post/requestBody/content/application~1json/examples/Batch"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_228","exampleIds":["paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Success","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Some fraud prevention list items are duplicated","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"]}},"schemaId":"schema_228","exampleIds":["paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Success","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Some fraud prevention list items are duplicated","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"]}],"pointer":"/paths/~1fraud-prevention-list-items~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_228","exampleIds":["paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Success","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Some fraud prevention list items are duplicated","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_228","exampleIds":["paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Success","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Some fraud prevention list items are duplicated","paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"]}}}],"examples":[]}]}]}]},"httpPath":"/fraud-prevention-list-items/create"},{"label":"List fraud prevention list items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fraud-prevention/fraud-prevention-list-items-list","routeSlug":"/api/fraud-prevention/fraud-prevention-list-items-list","metadata":{"seo":{"title":"List fraud prevention list items","description":"This method retrieves existing fraud prevention list items linked to the merchant's account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fraud-prevention-list-items-list","name":"List fraud prevention list items","isWebhook":false,"pointer":"/paths/~1fraud-prevention-list-items~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List fraud prevention list items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method retrieves existing fraud prevention list items linked to the merchant's account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1fraud-prevention-list-items~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestRisksFraudPreventionListItemList","exampleIds":["paths/~1fraud-prevention-list-items~1list/post/requestBody/content/application~1json/examples/Batch"]}},"schemaId":"components/schemas/RequestRisksFraudPreventionListItemList","exampleIds":["paths/~1fraud-prevention-list-items~1list/post/requestBody/content/application~1json/examples/Batch"],"pointer":"/paths/~1fraud-prevention-list-items~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fraud-prevention-list-items/list","servers":[{"url":"https://risks.solidgate.com/api/v1","description":"Risks management API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestRisksFraudPreventionListItemList","exampleIds":["paths/~1fraud-prevention-list-items~1list/post/requestBody/content/application~1json/examples/Batch"]}},"responseCodes":["200"],"pointer":"/fraud-prevention-list-items/list","href":"fraud-prevention/fraud-prevention-list-items-list","openApiOperationId":"fraud-prevention-list-items-list","summary":"List fraud prevention list items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://risks.solidgate.com/api/v1","description":"Risks management API"}],"schemaId":"components/schemas/RequestRisksFraudPreventionListItemList","exampleIds":["paths/~1fraud-prevention-list-items~1list/post/requestBody/content/application~1json/examples/Batch"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestRisksFraudPreventionListItemList","exampleIds":["paths/~1fraud-prevention-list-items~1list/post/requestBody/content/application~1json/examples/Batch"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229","exampleIds":["paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Success","paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled","paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"]}},"schemaId":"schema_229","exampleIds":["paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Success","paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled","paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"]}],"pointer":"/paths/~1fraud-prevention-list-items~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_229","exampleIds":["paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Success","paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled","paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229","exampleIds":["paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Success","paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled","paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"]}}}],"examples":[]}]}]}]},"httpPath":"/fraud-prevention-list-items/list"},{"label":"Delete fraud prevention list item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fraud-prevention/fraud-prevention-list-items-delete","routeSlug":"/api/fraud-prevention/fraud-prevention-list-items-delete","metadata":{"seo":{"title":"Delete fraud prevention list item","description":"This method allows you to delete an existing fraud prevention list item linked to the merchant's account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fraud-prevention-list-items-delete","name":"Delete fraud prevention list item","isWebhook":false,"pointer":"/paths/~1fraud-prevention-list-items~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete fraud prevention list item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method allows you to delete an existing fraud prevention list item linked to the merchant's account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_189","description":"Unique identifier of the fraud prevention list item to be deleted.","required":true}],"pointer":"/paths/~1fraud-prevention-list-items~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1fraud-prevention-list-items~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/fraud-prevention-list-items/{id}","servers":[{"url":"https://risks.solidgate.com/api/v1","description":"Risks management API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_189"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/fraud-prevention-list-items/{id}","href":"fraud-prevention/fraud-prevention-list-items-delete","openApiOperationId":"fraud-prevention-list-items-delete","summary":"Delete fraud prevention list item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://risks.solidgate.com/api/v1","description":"Risks management API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_230","exampleIds":["paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Success","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Authentication failed","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Item not found"]}},"schemaId":"schema_230","exampleIds":["paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Success","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Authentication failed","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Item not found"]}],"pointer":"/paths/~1fraud-prevention-list-items~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_230","exampleIds":["paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Success","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Authentication failed","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Item not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_230","exampleIds":["paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Success","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Authentication failed","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Invalid data","paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Item not found"]}}}],"examples":[]}]}]}]},"httpPath":"/fraud-prevention-list-items/{id}"}],"content":{"contentType":"group","meta":{"name":"Fraud prevention"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fraud prevention","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solidgate API for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/fraud/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fraud prevention"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enables merchants to set up and manage fraud prevention lists, helping to block fraudulent activities while ensuring secure transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By configuring fraud prevention lists, merchants can define specific conditions to allow or reject transactions, enhancing the security and reliability of their payment operations."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fraud-prevention-list-items/create","summary":"Create fraud prevention list items","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fraud-prevention/fraud-prevention-list-items-create","deprecated":false},{"title":"/fraud-prevention-list-items/list","summary":"List fraud prevention list items","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fraud-prevention/fraud-prevention-list-items-list","deprecated":false},{"title":"/fraud-prevention-list-items/{id}","summary":"Delete fraud prevention list item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/fraud-prevention/fraud-prevention-list-items-delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Dispute representment","link":"/api/dispute-representment","routeSlug":"/api/dispute-representment","items":[{"label":"Create dispute representment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/dispute-representment/dispute-representments-create","routeSlug":"/api/dispute-representment/dispute-representments-create","metadata":{"seo":{"title":"Create dispute representment","description":"This method allows you to initiate a dispute representment case with associated evidence files."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"dispute-representments-create","name":"Create dispute representment","isWebhook":false,"pointer":"/paths/~1dispute-representments~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create dispute representment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method allows you to initiate a dispute representment case with associated evidence "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/files-upload/create-upload-url","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1dispute-representments~1create/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestRisksDisputeRepresentmentsCreateDiscriminator","exampleIds":["paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/Card dispute representment","paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/PayPal dispute representment"]}},"schemaId":"components/schemas/RequestRisksDisputeRepresentmentsCreateDiscriminator","exampleIds":["paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/Card dispute representment","paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/PayPal dispute representment"],"pointer":"/paths/~1dispute-representments~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/dispute-representments/create","servers":[{"url":"https://risks.solidgate.com/api/v1","description":"Risks management API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestRisksDisputeRepresentmentsCreateDiscriminator","exampleIds":["paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/Card dispute representment","paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/PayPal dispute representment"]}},"responseCodes":["200","400","404","422"],"pointer":"/dispute-representments/create","href":"dispute-representment/dispute-representments-create","openApiOperationId":"dispute-representments-create","summary":"Create dispute representment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://risks.solidgate.com/api/v1","description":"Risks management API"}],"schemaId":"components/schemas/RequestRisksDisputeRepresentmentsCreateDiscriminator","exampleIds":["paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/Card dispute representment","paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/PayPal dispute representment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestRisksDisputeRepresentmentsCreateDiscriminator","exampleIds":["paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/Card dispute representment","paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/PayPal dispute representment"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1dispute-representments~1create/post/responses/200/content/application~1json/examples/Success","paths/~1dispute-representments~1create/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_231","exampleIds":["paths/~1dispute-representments~1create/post/responses/200/content/application~1json/examples/Success","paths/~1dispute-representments~1create/post/responses/200/content/application~1json/examples/Authentication failed"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest","exampleIds":["paths/~1dispute-representments~1create/post/responses/400/content/application~1json/examples/Error 2.01 Invalid data"]}},"schemaId":"components/schemas/ResponseBillingBadRequest","exampleIds":["paths/~1dispute-representments~1create/post/responses/400/content/application~1json/examples/Error 2.01 Invalid data"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRisksNotFoundError","exampleIds":["paths/~1dispute-representments~1create/post/responses/404/content/application~1json/examples/Error 2.01 Dispute not found","paths/~1dispute-representments~1create/post/responses/404/content/application~1json/examples/Error 2.01 File not found"]}},"schemaId":"components/schemas/ResponseRisksNotFoundError","exampleIds":["paths/~1dispute-representments~1create/post/responses/404/content/application~1json/examples/Error 2.01 Dispute not found","paths/~1dispute-representments~1create/post/responses/404/content/application~1json/examples/Error 2.01 File not found"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRisksError","exampleIds":["paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File not ready","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File size exceeded","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File type not supported","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 Representment already exists","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 Representment not possible"]}},"schemaId":"components/schemas/ResponseRisksError","exampleIds":["paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File not ready","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File size exceeded","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File type not supported","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 Representment already exists","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 Representment not possible"]}],"pointer":"/paths/~1dispute-representments~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_231","exampleIds":["paths/~1dispute-representments~1create/post/responses/200/content/application~1json/examples/Success","paths/~1dispute-representments~1create/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1dispute-representments~1create/post/responses/200/content/application~1json/examples/Success","paths/~1dispute-representments~1create/post/responses/200/content/application~1json/examples/Authentication failed"]}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","exampleIds":["paths/~1dispute-representments~1create/post/responses/400/content/application~1json/examples/Error 2.01 Invalid data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest","exampleIds":["paths/~1dispute-representments~1create/post/responses/400/content/application~1json/examples/Error 2.01 Invalid data"]}}},{"code":"404","schemaId":"components/schemas/ResponseRisksNotFoundError","exampleIds":["paths/~1dispute-representments~1create/post/responses/404/content/application~1json/examples/Error 2.01 Dispute not found","paths/~1dispute-representments~1create/post/responses/404/content/application~1json/examples/Error 2.01 File not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRisksNotFoundError","exampleIds":["paths/~1dispute-representments~1create/post/responses/404/content/application~1json/examples/Error 2.01 Dispute not found","paths/~1dispute-representments~1create/post/responses/404/content/application~1json/examples/Error 2.01 File not found"]}}},{"code":"422","schemaId":"components/schemas/ResponseRisksError","exampleIds":["paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File not ready","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File size exceeded","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File type not supported","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 Representment already exists","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 Representment not possible"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRisksError","exampleIds":["paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File not ready","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File size exceeded","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File type not supported","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 Representment already exists","paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 Representment not possible"]}}}],"examples":[]}]}]}]},"httpPath":"/dispute-representments/create"},{"label":"Enrich dispute representment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/dispute-representment/dispute-representments-enrich","routeSlug":"/api/dispute-representment/dispute-representments-enrich","metadata":{"seo":{"title":"Enrich dispute representment","description":"This method allows you to enrich dispute representment with additional content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"dispute-representments-enrich","name":"Enrich dispute representment","isWebhook":false,"pointer":"/paths/~1dispute-representments~1enrich/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich dispute representment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method allows you to enrich dispute representment with additional content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1dispute-representments~1enrich/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestRisksDisputeRepresentmentsEnrichDiscriminator","exampleIds":["paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/Card dispute representment enrichment","paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/PayPal dispute representment enrichment"]}},"schemaId":"components/schemas/RequestRisksDisputeRepresentmentsEnrichDiscriminator","exampleIds":["paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/Card dispute representment enrichment","paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/PayPal dispute representment enrichment"],"pointer":"/paths/~1dispute-representments~1enrich/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/dispute-representments/enrich","servers":[{"url":"https://risks.solidgate.com/api/v1","description":"Risks management API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestRisksDisputeRepresentmentsEnrichDiscriminator","exampleIds":["paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/Card dispute representment enrichment","paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/PayPal dispute representment enrichment"]}},"responseCodes":["200","400","404","422"],"pointer":"/dispute-representments/enrich","href":"dispute-representment/dispute-representments-enrich","openApiOperationId":"dispute-representments-enrich","summary":"Enrich dispute representment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://risks.solidgate.com/api/v1","description":"Risks management API"}],"schemaId":"components/schemas/RequestRisksDisputeRepresentmentsEnrichDiscriminator","exampleIds":["paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/Card dispute representment enrichment","paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/PayPal dispute representment enrichment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestRisksDisputeRepresentmentsEnrichDiscriminator","exampleIds":["paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/Card dispute representment enrichment","paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/PayPal dispute representment enrichment"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_232","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/200/content/application~1json/examples/Success","paths/~1dispute-representments~1enrich/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_232","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/200/content/application~1json/examples/Success","paths/~1dispute-representments~1enrich/post/responses/200/content/application~1json/examples/Authentication failed"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/400/content/application~1json/examples/Error 2.01 Invalid data"]}},"schemaId":"components/schemas/ResponseBillingBadRequest","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/400/content/application~1json/examples/Error 2.01 Invalid data"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRisksNotFoundError","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/404/content/application~1json/examples/Error 2.01 Dispute not found","paths/~1dispute-representments~1enrich/post/responses/404/content/application~1json/examples/Error 2.01 File not found"]}},"schemaId":"components/schemas/ResponseRisksNotFoundError","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/404/content/application~1json/examples/Error 2.01 Dispute not found","paths/~1dispute-representments~1enrich/post/responses/404/content/application~1json/examples/Error 2.01 File not found"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRisksEnrichError","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File not ready","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File size exceeded","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 Total files size exceeded","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File type not supported","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 Enrichment not possible"]}},"schemaId":"components/schemas/ResponseRisksEnrichError","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File not ready","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File size exceeded","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 Total files size exceeded","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File type not supported","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 Enrichment not possible"]}],"pointer":"/paths/~1dispute-representments~1enrich/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_232","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/200/content/application~1json/examples/Success","paths/~1dispute-representments~1enrich/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_232","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/200/content/application~1json/examples/Success","paths/~1dispute-representments~1enrich/post/responses/200/content/application~1json/examples/Authentication failed"]}}},{"code":"400","schemaId":"components/schemas/ResponseBillingBadRequest","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/400/content/application~1json/examples/Error 2.01 Invalid data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseBillingBadRequest","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/400/content/application~1json/examples/Error 2.01 Invalid data"]}}},{"code":"404","schemaId":"components/schemas/ResponseRisksNotFoundError","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/404/content/application~1json/examples/Error 2.01 Dispute not found","paths/~1dispute-representments~1enrich/post/responses/404/content/application~1json/examples/Error 2.01 File not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRisksNotFoundError","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/404/content/application~1json/examples/Error 2.01 Dispute not found","paths/~1dispute-representments~1enrich/post/responses/404/content/application~1json/examples/Error 2.01 File not found"]}}},{"code":"422","schemaId":"components/schemas/ResponseRisksEnrichError","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File not ready","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File size exceeded","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 Total files size exceeded","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File type not supported","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 Enrichment not possible"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRisksEnrichError","exampleIds":["paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File not ready","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File size exceeded","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 Total files size exceeded","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File type not supported","paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 Enrichment not possible"]}}}],"examples":[]}]}]}]},"httpPath":"/dispute-representments/enrich"}],"content":{"contentType":"group","meta":{"name":"Dispute representment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dispute representment","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solidgate API for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#respond-to-chargebacks","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card dispute representment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/manage/#dispute-representment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal dispute representment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enables merchants to defend card and PayPal disputes by uploading evidence files, helping to protect revenue and resolve disputed orders efficiently."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/dispute-representments/create","summary":"Create dispute representment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dispute-representment/dispute-representments-create","deprecated":false},{"title":"/dispute-representments/enrich","summary":"Enrich dispute representment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dispute-representment/dispute-representments-enrich","deprecated":false}]}]}]}]}},{"type":"separator","label":"Checkout solutions","content":null},{"type":"group","label":"Payment page","link":"/api/payment-page","routeSlug":"/api/payment-page","items":[{"label":"Create page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-page/create-payment-page","routeSlug":"/api/payment-page/create-payment-page","metadata":{"seo":{"title":"Create page","description":"Please note that the payment page link expires in 24 hours."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-payment-page","name":"Create page","isWebhook":false,"pointer":"/paths/~1init/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Please note that the payment page link "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"expires in 24 hours"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1init/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_233","exampleIds":["paths/~1init/post/requestBody/content/application~1json/examples/Payment","paths/~1init/post/requestBody/content/application~1json/examples/Subscription payment","paths/~1init/post/requestBody/content/application~1json/examples/Invoice payment"]}},"schemaId":"schema_233","exampleIds":["paths/~1init/post/requestBody/content/application~1json/examples/Payment","paths/~1init/post/requestBody/content/application~1json/examples/Subscription payment","paths/~1init/post/requestBody/content/application~1json/examples/Invoice payment"],"pointer":"/paths/~1init/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/init","servers":[{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_233","exampleIds":["paths/~1init/post/requestBody/content/application~1json/examples/Payment","paths/~1init/post/requestBody/content/application~1json/examples/Subscription payment","paths/~1init/post/requestBody/content/application~1json/examples/Invoice payment"]}},"responseCodes":["200"],"pointer":"/init","href":"payment-page/create-payment-page","openApiOperationId":"create-payment-page","summary":"Create page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page Live API"}],"schemaId":"schema_233","exampleIds":["paths/~1init/post/requestBody/content/application~1json/examples/Payment","paths/~1init/post/requestBody/content/application~1json/examples/Subscription payment","paths/~1init/post/requestBody/content/application~1json/examples/Invoice payment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_233","exampleIds":["paths/~1init/post/requestBody/content/application~1json/examples/Payment","paths/~1init/post/requestBody/content/application~1json/examples/Subscription payment","paths/~1init/post/requestBody/content/application~1json/examples/Invoice payment"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_234","exampleIds":["paths/~1init/post/responses/200/content/application~1json/examples/Success","paths/~1init/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1init/post/responses/200/content/application~1json/examples/Error"]}},"schemaId":"schema_234","exampleIds":["paths/~1init/post/responses/200/content/application~1json/examples/Success","paths/~1init/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1init/post/responses/200/content/application~1json/examples/Error"]}],"pointer":"/paths/~1init/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_234","exampleIds":["paths/~1init/post/responses/200/content/application~1json/examples/Success","paths/~1init/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1init/post/responses/200/content/application~1json/examples/Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_234","exampleIds":["paths/~1init/post/responses/200/content/application~1json/examples/Success","paths/~1init/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1init/post/responses/200/content/application~1json/examples/Error"]}}}],"examples":[]}]}]}]},"httpPath":"/init"},{"label":"Deactivate page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-page/deactivate-payment-page","routeSlug":"/api/payment-page/deactivate-payment-page","metadata":{"seo":{"title":"Deactivate page","description":"Deactivate an active payment page to prevent further use."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivate-payment-page","name":"Deactivate page","isWebhook":false,"pointer":"/paths/~1deactivate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deactivate an active payment page to prevent further use."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1deactivate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCheckoutSolutionsDeactivatePage"}},"schemaId":"components/schemas/RequestCheckoutSolutionsDeactivatePage","pointer":"/paths/~1deactivate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/deactivate","servers":[{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCheckoutSolutionsDeactivatePage"}},"responseCodes":["200","400"],"pointer":"/deactivate","href":"payment-page/deactivate-payment-page","openApiOperationId":"deactivate-payment-page","summary":"Deactivate page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page Live API"}],"schemaId":"components/schemas/RequestCheckoutSolutionsDeactivatePage","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCheckoutSolutionsDeactivatePage"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request received"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #1d8126","marginLeft":"20px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{"style":{"color":"#1d8126","marginLeft":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Response either confirms success or returns error object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_235","exampleIds":["paths/~1deactivate/post/responses/200/content/application~1json/examples/Success","paths/~1deactivate/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_235","exampleIds":["paths/~1deactivate/post/responses/200/content/application~1json/examples/Success","paths/~1deactivate/post/responses/200/content/application~1json/examples/Authentication failed"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_236","exampleIds":["paths/~1deactivate/post/responses/400/content/application~1json/examples/Validation error"]}},"schemaId":"schema_236","exampleIds":["paths/~1deactivate/post/responses/400/content/application~1json/examples/Validation error"]}],"pointer":"/paths/~1deactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_235","exampleIds":["paths/~1deactivate/post/responses/200/content/application~1json/examples/Success","paths/~1deactivate/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_235","exampleIds":["paths/~1deactivate/post/responses/200/content/application~1json/examples/Success","paths/~1deactivate/post/responses/200/content/application~1json/examples/Authentication failed"]}}},{"code":"400","schemaId":"schema_236","exampleIds":["paths/~1deactivate/post/responses/400/content/application~1json/examples/Validation error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_236","exampleIds":["paths/~1deactivate/post/responses/400/content/application~1json/examples/Validation error"]}}}],"examples":[]}]}]}]},"httpPath":"/deactivate"}],"content":{"contentType":"group","meta":{"name":"Payment page"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment page","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solidgate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/create-your-payment-page/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Page"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows merchants to securely redirect customers to a payment gateway's hosted page for completing transactions, without the need for custom integration on the merchant's website."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/init","summary":"Create page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-page/create-payment-page","deprecated":false},{"title":"/deactivate","summary":"Deactivate page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-page/deactivate-payment-page","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment link","link":"/api/payment-link","routeSlug":"/api/payment-link","items":[{"label":"Create link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-link/create-payment-link","routeSlug":"/api/payment-link/create-payment-link","metadata":{"seo":{"title":"Create link","description":"Payment links are code-free and reusable, allowing you to share them as many times as needed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-payment-link","name":"Create link","isWebhook":false,"pointer":"/paths/~1link~1init/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Payment links are code-free and reusable, allowing you to share them as many times as needed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1link~1init/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_237","exampleIds":["paths/~1link~1init/post/requestBody/content/application~1json/examples/Payment","paths/~1link~1init/post/requestBody/content/application~1json/examples/Subscription payment","paths/~1link~1init/post/requestBody/content/application~1json/examples/Invoice payment"]}},"schemaId":"schema_237","exampleIds":["paths/~1link~1init/post/requestBody/content/application~1json/examples/Payment","paths/~1link~1init/post/requestBody/content/application~1json/examples/Subscription payment","paths/~1link~1init/post/requestBody/content/application~1json/examples/Invoice payment"],"pointer":"/paths/~1link~1init/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/link/init","servers":[{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Link Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_237","exampleIds":["paths/~1link~1init/post/requestBody/content/application~1json/examples/Payment","paths/~1link~1init/post/requestBody/content/application~1json/examples/Subscription payment","paths/~1link~1init/post/requestBody/content/application~1json/examples/Invoice payment"]}},"responseCodes":["200"],"pointer":"/link/init","href":"payment-link/create-payment-link","openApiOperationId":"create-payment-link","summary":"Create link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Link Live API"}],"schemaId":"schema_237","exampleIds":["paths/~1link~1init/post/requestBody/content/application~1json/examples/Payment","paths/~1link~1init/post/requestBody/content/application~1json/examples/Subscription payment","paths/~1link~1init/post/requestBody/content/application~1json/examples/Invoice payment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_237","exampleIds":["paths/~1link~1init/post/requestBody/content/application~1json/examples/Payment","paths/~1link~1init/post/requestBody/content/application~1json/examples/Subscription payment","paths/~1link~1init/post/requestBody/content/application~1json/examples/Invoice payment"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_238","exampleIds":["paths/~1link~1init/post/responses/200/content/application~1json/examples/Success","paths/~1link~1init/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1link~1init/post/responses/200/content/application~1json/examples/Error"]}},"schemaId":"schema_238","exampleIds":["paths/~1link~1init/post/responses/200/content/application~1json/examples/Success","paths/~1link~1init/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1link~1init/post/responses/200/content/application~1json/examples/Error"]}],"pointer":"/paths/~1link~1init/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_238","exampleIds":["paths/~1link~1init/post/responses/200/content/application~1json/examples/Success","paths/~1link~1init/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1link~1init/post/responses/200/content/application~1json/examples/Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_238","exampleIds":["paths/~1link~1init/post/responses/200/content/application~1json/examples/Success","paths/~1link~1init/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1link~1init/post/responses/200/content/application~1json/examples/Error"]}}}],"examples":[]}]}]}]},"httpPath":"/link/init"},{"label":"Deactivate link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-link/deactivate-payment-link","routeSlug":"/api/payment-link/deactivate-payment-link","metadata":{"seo":{"title":"Deactivate link","description":"Deactivate an active payment link to prevent further use."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivate-payment-link","name":"Deactivate link","isWebhook":false,"pointer":"/paths/~1link~1deactivate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deactivate an active payment link to prevent further use."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1link~1deactivate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCheckoutSolutionsDeactivateLink"}},"schemaId":"components/schemas/RequestCheckoutSolutionsDeactivateLink","pointer":"/paths/~1link~1deactivate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/link/deactivate","servers":[{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Link Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCheckoutSolutionsDeactivateLink"}},"responseCodes":["200"],"pointer":"/link/deactivate","href":"payment-link/deactivate-payment-link","openApiOperationId":"deactivate-payment-link","summary":"Deactivate link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Link Live API"}],"schemaId":"components/schemas/RequestCheckoutSolutionsDeactivateLink","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCheckoutSolutionsDeactivateLink"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request received"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #1d8126","marginLeft":"20px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{"style":{"color":"#1d8126","marginLeft":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Response either confirms success or returns error object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_239","exampleIds":["paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Success","paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Validation error"]}},"schemaId":"schema_239","exampleIds":["paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Success","paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Validation error"]}],"pointer":"/paths/~1link~1deactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_239","exampleIds":["paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Success","paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Validation error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_239","exampleIds":["paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Success","paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Validation error"]}}}],"examples":[]}]}]}]},"httpPath":"/link/deactivate"}],"content":{"contentType":"group","meta":{"name":"Payment link"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment link","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solidgate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-link/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Link"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature offers a hassle-free way to conduct online sales without integration, allowing merchants to share a URL that leads customers to a secure payment page for both one-time and subscription transactions."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/link/init","summary":"Create link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-link/create-payment-link","deprecated":false},{"title":"/link/deactivate","summary":"Deactivate link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-link/deactivate-payment-link","deprecated":false}]}]}]}]}},{"type":"separator","label":"Webhooks","content":null},{"type":"group","label":"Manage webhooks","link":"/api/manage-webhooks","routeSlug":"/api/manage-webhooks","items":[{"label":"Create webhook endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-webhooks/webhook-endpoint-create","routeSlug":"/api/manage-webhooks/webhook-endpoint-create","metadata":{"seo":{"title":"Create webhook endpoint","description":"This method allows you to configure a webhook endpoint to receive specified events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-endpoint-create","name":"Create webhook endpoint","isWebhook":false,"pointer":"/paths/~1webhooks~1endpoints/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method allows you to configure a webhook endpoint to receive specified events."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Two identical URLs cannot be configured for one channel."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1webhooks~1endpoints/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestWebhooksEndpointCreate","exampleIds":["paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/Without status","paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/With status"]}},"schemaId":"components/schemas/RequestWebhooksEndpointCreate","exampleIds":["paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/Without status","paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/With status"],"pointer":"/paths/~1webhooks~1endpoints/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhooks/endpoints","servers":[{"url":"https://api.solidgate.com/api/v1","description":"Webhooks management API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestWebhooksEndpointCreate","exampleIds":["paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/Without status","paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/With status"]}},"responseCodes":["200","400","422"],"pointer":"/webhooks/endpoints","href":"manage-webhooks/webhook-endpoint-create","openApiOperationId":"webhook-endpoint-create","summary":"Create webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.solidgate.com/api/v1","description":"Webhooks management API"}],"schemaId":"components/schemas/RequestWebhooksEndpointCreate","exampleIds":["paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/Without status","paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/With status"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestWebhooksEndpointCreate","exampleIds":["paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/Without status","paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/With status"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_240","exampleIds":["paths/~1webhooks~1endpoints/post/responses/200/content/application~1json/examples/Success","paths/~1webhooks~1endpoints/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_240","exampleIds":["paths/~1webhooks~1endpoints/post/responses/200/content/application~1json/examples/Success","paths/~1webhooks~1endpoints/post/responses/200/content/application~1json/examples/Authentication failed"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseWebhooksInvalidRequest","exampleIds":["paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid json","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid url","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid event_type","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid status","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Name max length","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 URL max length"]}},"schemaId":"components/schemas/ResponseWebhooksInvalidRequest","exampleIds":["paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid json","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid url","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid event_type","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid status","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Name max length","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 URL max length"]},{"code":"422","description":"Endpoint with the same URL already exists for this channel","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseWebhooksEndpointAlreadyExists","exampleIds":["paths/~1webhooks~1endpoints/post/responses/422/content/application~1json/examples/Error 2.01 Endpoint already exists","paths/~1webhooks~1endpoints/post/responses/422/content/application~1json/examples/Error 2.01 Endpoint limit reached"]}},"schemaId":"components/schemas/ResponseWebhooksEndpointAlreadyExists","exampleIds":["paths/~1webhooks~1endpoints/post/responses/422/content/application~1json/examples/Error 2.01 Endpoint already exists","paths/~1webhooks~1endpoints/post/responses/422/content/application~1json/examples/Error 2.01 Endpoint limit reached"]}],"pointer":"/paths/~1webhooks~1endpoints/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_240","exampleIds":["paths/~1webhooks~1endpoints/post/responses/200/content/application~1json/examples/Success","paths/~1webhooks~1endpoints/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_240","exampleIds":["paths/~1webhooks~1endpoints/post/responses/200/content/application~1json/examples/Success","paths/~1webhooks~1endpoints/post/responses/200/content/application~1json/examples/Authentication failed"]}}},{"code":"400","schemaId":"components/schemas/ResponseWebhooksInvalidRequest","exampleIds":["paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid json","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid url","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid event_type","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid status","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Name max length","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 URL max length"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseWebhooksInvalidRequest","exampleIds":["paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid json","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid url","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid event_type","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid status","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Name max length","paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 URL max length"]}}},{"code":"422","schemaId":"components/schemas/ResponseWebhooksEndpointAlreadyExists","exampleIds":["paths/~1webhooks~1endpoints/post/responses/422/content/application~1json/examples/Error 2.01 Endpoint already exists","paths/~1webhooks~1endpoints/post/responses/422/content/application~1json/examples/Error 2.01 Endpoint limit reached"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseWebhooksEndpointAlreadyExists","exampleIds":["paths/~1webhooks~1endpoints/post/responses/422/content/application~1json/examples/Error 2.01 Endpoint already exists","paths/~1webhooks~1endpoints/post/responses/422/content/application~1json/examples/Error 2.01 Endpoint limit reached"]}}}],"examples":[]}]}]}]},"httpPath":"/webhooks/endpoints"},{"label":"List webhook endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-webhooks/webhook-endpoint-list","routeSlug":"/api/manage-webhooks/webhook-endpoint-list","metadata":{"seo":{"title":"List webhook endpoints","description":"This method retrieves a list of your previously created webhook endpoints."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-endpoint-list","name":"List webhook endpoints","isWebhook":false,"pointer":"/paths/~1webhooks~1endpoints/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List webhook endpoints","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method retrieves a list of your previously created webhook endpoints."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[id]","in":"query","schemaId":"schema_241","description":"Comma-separated webhook identifiers."},{"name":"pagination[limit]","in":"query","schemaId":"schema_242"},{"name":"pagination[offset]","in":"query","schemaId":"schema_243"}],"pointer":"/paths/~1webhooks~1endpoints/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1webhooks~1endpoints/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks/endpoints","servers":[{"url":"https://api.solidgate.com/api/v1","description":"Webhooks management API"}],"parameters":{"path":[],"query":[{"name":"filter[id]","in":"query","example":"ac43b415-5522-4373-b026-a365462f9657","schemaId":"schema_241"},{"name":"pagination[limit]","in":"query","example":10,"schemaId":"schema_242"},{"name":"pagination[offset]","in":"query","example":10,"schemaId":"schema_243"}],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/webhooks/endpoints","href":"manage-webhooks/webhook-endpoint-list","openApiOperationId":"webhook-endpoint-list","summary":"List webhook endpoints"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.solidgate.com/api/v1","description":"Webhooks management API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_244","exampleIds":["paths/~1webhooks~1endpoints/get/responses/200/content/application~1json/examples/Success","paths/~1webhooks~1endpoints/get/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_244","exampleIds":["paths/~1webhooks~1endpoints/get/responses/200/content/application~1json/examples/Success","paths/~1webhooks~1endpoints/get/responses/200/content/application~1json/examples/Authentication failed"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseWebhooksInvalidRequest","exampleIds":["paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Invalid limit","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Limit out of range","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Invalid offset","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Negative offset","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 ID list exceeds maximum length","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Empty id in list"]}},"schemaId":"components/schemas/ResponseWebhooksInvalidRequest","exampleIds":["paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Invalid limit","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Limit out of range","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Invalid offset","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Negative offset","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 ID list exceeds maximum length","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Empty id in list"]}],"pointer":"/paths/~1webhooks~1endpoints/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_244","exampleIds":["paths/~1webhooks~1endpoints/get/responses/200/content/application~1json/examples/Success","paths/~1webhooks~1endpoints/get/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_244","exampleIds":["paths/~1webhooks~1endpoints/get/responses/200/content/application~1json/examples/Success","paths/~1webhooks~1endpoints/get/responses/200/content/application~1json/examples/Authentication failed"]}}},{"code":"400","schemaId":"components/schemas/ResponseWebhooksInvalidRequest","exampleIds":["paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Invalid limit","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Limit out of range","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Invalid offset","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Negative offset","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 ID list exceeds maximum length","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Empty id in list"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseWebhooksInvalidRequest","exampleIds":["paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Invalid limit","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Limit out of range","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Invalid offset","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Negative offset","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 ID list exceeds maximum length","paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Empty id in list"]}}}],"examples":[]}]}]}]},"httpPath":"/webhooks/endpoints"},{"label":"Update webhook endpoint","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-webhooks/webhook-endpoint-update","routeSlug":"/api/manage-webhooks/webhook-endpoint-update","metadata":{"seo":{"title":"Update webhook endpoint","description":"This method allows you to update an existing webhook endpoint. For that, you need to provide the endpoint identifier and the new configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-endpoint-update","name":"Update webhook endpoint","isWebhook":false,"pointer":"/paths/~1webhooks~1endpoints~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method allows you to update an existing webhook endpoint.\nFor that, you need to provide the endpoint identifier and the new configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_189","description":"Webhook endpoint identifier.","required":true}],"pointer":"/paths/~1webhooks~1endpoints~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1webhooks~1endpoints~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestWebhooksEndpointUpdate","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update all","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update event_types","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update status","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update name","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update url"]}},"schemaId":"components/schemas/RequestWebhooksEndpointUpdate","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update all","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update event_types","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update status","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update name","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update url"],"pointer":"/paths/~1webhooks~1endpoints~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/webhooks/endpoints/{id}","servers":[{"url":"https://api.solidgate.com/api/v1","description":"Webhooks management API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_189"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestWebhooksEndpointUpdate","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update all","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update event_types","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update status","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update name","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update url"]}},"responseCodes":["200","400","404","422"],"pointer":"/webhooks/endpoints/{id}","href":"manage-webhooks/webhook-endpoint-update","openApiOperationId":"webhook-endpoint-update","summary":"Update webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.solidgate.com/api/v1","description":"Webhooks management API"}],"schemaId":"components/schemas/RequestWebhooksEndpointUpdate","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update all","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update event_types","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update status","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update name","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update url"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestWebhooksEndpointUpdate","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update all","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update event_types","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update status","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update name","paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update url"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_240","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/200/content/application~1json/examples/Success","paths/~1webhooks~1endpoints~1{id}/patch/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_240","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/200/content/application~1json/examples/Success","paths/~1webhooks~1endpoints~1{id}/patch/responses/200/content/application~1json/examples/Authentication failed"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseWebhooksInvalidRequest","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid json","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid event_type","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid status","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Name max length","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid url"]}},"schemaId":"components/schemas/ResponseWebhooksInvalidRequest","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid json","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid event_type","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid status","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Name max length","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid url"]},{"code":"404","description":"Endpoint not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseWebhooksEndpointNotFound","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/404/content/application~1json/examples/Error 2.01 Endpoint not found"]}},"schemaId":"components/schemas/ResponseWebhooksEndpointNotFound","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/404/content/application~1json/examples/Error 2.01 Endpoint not found"]},{"code":"422","description":"Endpoint with the same URL already exists for this channel","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseWebhooksEndpointAlreadyExists","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/422/content/application~1json/examples/Error 2.01 Endpoint already exists"]}},"schemaId":"components/schemas/ResponseWebhooksEndpointAlreadyExists","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/422/content/application~1json/examples/Error 2.01 Endpoint already exists"]}],"pointer":"/paths/~1webhooks~1endpoints~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_240","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/200/content/application~1json/examples/Success","paths/~1webhooks~1endpoints~1{id}/patch/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_240","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/200/content/application~1json/examples/Success","paths/~1webhooks~1endpoints~1{id}/patch/responses/200/content/application~1json/examples/Authentication failed"]}}},{"code":"400","schemaId":"components/schemas/ResponseWebhooksInvalidRequest","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid json","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid event_type","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid status","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Name max length","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid url"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseWebhooksInvalidRequest","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid json","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid event_type","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid status","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Name max length","paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid url"]}}},{"code":"404","schemaId":"components/schemas/ResponseWebhooksEndpointNotFound","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/404/content/application~1json/examples/Error 2.01 Endpoint not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseWebhooksEndpointNotFound","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/404/content/application~1json/examples/Error 2.01 Endpoint not found"]}}},{"code":"422","schemaId":"components/schemas/ResponseWebhooksEndpointAlreadyExists","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/422/content/application~1json/examples/Error 2.01 Endpoint already exists"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseWebhooksEndpointAlreadyExists","exampleIds":["paths/~1webhooks~1endpoints~1{id}/patch/responses/422/content/application~1json/examples/Error 2.01 Endpoint already exists"]}}}],"examples":[]}]}]}]},"httpPath":"/webhooks/endpoints/{id}"},{"label":"Delete webhook endpoint","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-webhooks/webhook-endpoint-delete","routeSlug":"/api/manage-webhooks/webhook-endpoint-delete","metadata":{"seo":{"title":"Delete webhook endpoint","description":"This method allows you to delete an existing webhook endpoint. For that, you need to provide the endpoint identifier you want to delete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-endpoint-delete","name":"Delete webhook endpoint","isWebhook":false,"pointer":"/paths/~1webhooks~1endpoints~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method allows you to delete an existing webhook endpoint.\nFor that, you need to provide the endpoint identifier you want to delete."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_189","description":"Webhook endpoint identifier.","required":true}],"pointer":"/paths/~1webhooks~1endpoints~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1webhooks~1endpoints~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/webhooks/endpoints/{id}","servers":[{"url":"https://api.solidgate.com/api/v1","description":"Webhooks management API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_189"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200","204"],"pointer":"/webhooks/endpoints/{id}","href":"manage-webhooks/webhook-endpoint-delete","openApiOperationId":"webhook-endpoint-delete","summary":"Delete webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.solidgate.com/api/v1","description":"Webhooks management API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request received"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #1d8126","marginLeft":"20px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{"style":{"color":"#1d8126","marginLeft":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Response either confirms success or returns error object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAuthenticationFailed","exampleIds":["paths/~1webhooks~1endpoints~1{id}/delete/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"components/schemas/ResponseMainAuthenticationFailed","exampleIds":["paths/~1webhooks~1endpoints~1{id}/delete/responses/200/content/application~1json/examples/Authentication failed"]},{"code":"204","description":"Webhook endpoint has been deleted"}],"pointer":"/paths/~1webhooks~1endpoints~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseMainAuthenticationFailed","exampleIds":["paths/~1webhooks~1endpoints~1{id}/delete/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseMainAuthenticationFailed","exampleIds":["paths/~1webhooks~1endpoints~1{id}/delete/responses/200/content/application~1json/examples/Authentication failed"]}}},{"code":"204"}],"examples":[]}]}]}]},"httpPath":"/webhooks/endpoints/{id}"}],"content":{"contentType":"group","meta":{"name":"Manage webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manage webhooks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solidgate API for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows merchants to create, update, list, and delete webhook endpoint configurations."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/webhooks/endpoints","summary":"Create webhook endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-webhooks/webhook-endpoint-create","deprecated":false},{"title":"/webhooks/endpoints","summary":"List webhook endpoints","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manage-webhooks/webhook-endpoint-list","deprecated":false},{"title":"/webhooks/endpoints/{id}","summary":"Update webhook endpoint","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/manage-webhooks/webhook-endpoint-update","deprecated":false},{"title":"/webhooks/endpoints/{id}","summary":"Delete webhook endpoint","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/manage-webhooks/webhook-endpoint-delete","deprecated":false}]}]}]}]}},{"type":"separator","label":"Reporting","content":null},{"type":"group","label":"Reports","link":"/api/reports","routeSlug":"/api/reports","items":[{"label":"Card orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/retrieve-card-orders","routeSlug":"/api/reports/retrieve-card-orders","metadata":{"seo":{"title":"Card orders","description":"The report provides essential data for merchants, including transaction details, customer information, and technical insights, facilitating comprehensive order tracking, financial reconciliation, and enhanced operational and marketing strategies."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-card-orders","name":"Card orders","isWebhook":false,"pointer":"/paths/~1card-orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/reporting/operational-reports/card-orders/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides essential data for merchants, including transaction details, customer information, and technical insights, facilitating comprehensive order tracking, financial reconciliation, and enhanced operational and marketing strategies."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This report uses the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"updated_at"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the default parameter for unloading data, which reflects the latest update to card orders."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1card-orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_245"}},"schemaId":"schema_245","pointer":"/paths/~1card-orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/card-orders","servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_245"}},"responseCodes":["200"],"pointer":"/card-orders","href":"reports/retrieve-card-orders","openApiOperationId":"retrieve-card-orders","summary":"Card orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"schemaId":"schema_245","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_245"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_246","exampleIds":["paths/~1card-orders/post/responses/200/content/application~1json/examples/Success","paths/~1card-orders/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_246","exampleIds":["paths/~1card-orders/post/responses/200/content/application~1json/examples/Success","paths/~1card-orders/post/responses/200/content/application~1json/examples/Authentication failed"]}],"pointer":"/paths/~1card-orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_246","exampleIds":["paths/~1card-orders/post/responses/200/content/application~1json/examples/Success","paths/~1card-orders/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_246","exampleIds":["paths/~1card-orders/post/responses/200/content/application~1json/examples/Success","paths/~1card-orders/post/responses/200/content/application~1json/examples/Authentication failed"]}}}],"examples":[]}]}]}]},"httpPath":"/card-orders"},{"label":"APM orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/retrieve-apm-orders","routeSlug":"/api/reports/retrieve-apm-orders","metadata":{"seo":{"title":"APM orders","description":"The report is essential for merchants using alternative payment methods, offering comprehensive transaction details, including order IDs, statuses, amounts, customer information, crucial for a complete understanding of APM transaction dynamics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-apm-orders","name":"APM orders","isWebhook":false,"pointer":"/paths/~1apm-orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"APM orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/reporting/operational-reports/apm-orders/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is essential for merchants using alternative payment methods, offering comprehensive transaction details, including order IDs, statuses, amounts, customer information, crucial for a complete understanding of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction dynamics."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This report uses the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"updated_at"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the default parameter for unloading data, indicating the latest update to the APM orders."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1apm-orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_245"}},"schemaId":"schema_245","pointer":"/paths/~1apm-orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/apm-orders","servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_245"}},"responseCodes":["200"],"pointer":"/apm-orders","href":"reports/retrieve-apm-orders","openApiOperationId":"retrieve-apm-orders","summary":"APM orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"schemaId":"schema_245","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_245"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_247","exampleIds":["paths/~1apm-orders/post/responses/200/content/application~1json/examples/Success","paths/~1apm-orders/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_247","exampleIds":["paths/~1apm-orders/post/responses/200/content/application~1json/examples/Success","paths/~1apm-orders/post/responses/200/content/application~1json/examples/Authentication failed"]}],"pointer":"/paths/~1apm-orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_247","exampleIds":["paths/~1apm-orders/post/responses/200/content/application~1json/examples/Success","paths/~1apm-orders/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_247","exampleIds":["paths/~1apm-orders/post/responses/200/content/application~1json/examples/Success","paths/~1apm-orders/post/responses/200/content/application~1json/examples/Authentication failed"]}}}],"examples":[]}]}]}]},"httpPath":"/apm-orders"},{"label":"Subscriptions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/retrieve-subscriptions","routeSlug":"/api/reports/retrieve-subscriptions","metadata":{"seo":{"title":"Subscriptions","description":"The report offers a comprehensive overview for merchants, detailing customer subscriptions, payment methods, key customer data, and associated invoices, which are important for managing recurring revenues, customer retention, and informed decision-making in subscription-based businesses."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-subscriptions","name":"Subscriptions","isWebhook":false,"pointer":"/paths/~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/reporting/operational-reports/subscriptions/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" offers a comprehensive overview for merchants, detailing customer subscriptions, payment methods, key customer data, and associated invoices, which are important for managing recurring revenues, customer retention, and informed decision-making in subscription-based businesses."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"updated_at"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" parameter is used when unloading subscription data, indicating the most recent update to a subscription."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_248"}},"schemaId":"schema_248","pointer":"/paths/~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions","servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_248"}},"responseCodes":["200"],"pointer":"/subscriptions","href":"reports/retrieve-subscriptions","openApiOperationId":"retrieve-subscriptions","summary":"Subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"schemaId":"schema_248","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_248"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_249","exampleIds":["paths/~1subscriptions/post/responses/200/content/application~1json/examples/Success","paths/~1subscriptions/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_249","exampleIds":["paths/~1subscriptions/post/responses/200/content/application~1json/examples/Success","paths/~1subscriptions/post/responses/200/content/application~1json/examples/Authentication failed"]}],"pointer":"/paths/~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_249","exampleIds":["paths/~1subscriptions/post/responses/200/content/application~1json/examples/Success","paths/~1subscriptions/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_249","exampleIds":["paths/~1subscriptions/post/responses/200/content/application~1json/examples/Success","paths/~1subscriptions/post/responses/200/content/application~1json/examples/Authentication failed"]}}}],"examples":[]}]}]}]},"httpPath":"/subscriptions"},{"label":"Chargebacks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/retrieve-card-chargebacks","routeSlug":"/api/reports/retrieve-card-chargebacks","metadata":{"seo":{"title":"Chargebacks","description":"The report is essential for merchants, providing exhaustive insights into each chargeback, including identifiers, dates, types, amounts, reasons, and related original order details, which is crucial for understanding chargeback patterns, enhancing dispute resolution, and fraud prevention."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-card-chargebacks","name":"Chargebacks","isWebhook":false,"pointer":"/paths/~1card-orders~1chargebacks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Chargebacks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/reporting/operational-reports/chargebacks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is essential for merchants, providing exhaustive insights into each chargeback, including identifiers, dates, types, amounts, reasons, and related original order details, which is crucial for understanding "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargeback"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" patterns, enhancing dispute resolution, and fraud prevention."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Chargeback information is unloaded using the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"updated_at"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the default parameter, which reflects the date when the latest chargeback flow was created."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1card-orders~1chargebacks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_245"}},"schemaId":"schema_245","pointer":"/paths/~1card-orders~1chargebacks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/card-orders/chargebacks","servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_245"}},"responseCodes":["200"],"pointer":"/card-orders/chargebacks","href":"reports/retrieve-card-chargebacks","openApiOperationId":"retrieve-card-chargebacks","summary":"Chargebacks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"schemaId":"schema_245","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_245"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_250","exampleIds":["paths/~1card-orders~1chargebacks/post/responses/200/content/application~1json/examples/Success","paths/~1card-orders~1chargebacks/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_250","exampleIds":["paths/~1card-orders~1chargebacks/post/responses/200/content/application~1json/examples/Success","paths/~1card-orders~1chargebacks/post/responses/200/content/application~1json/examples/Authentication failed"]}],"pointer":"/paths/~1card-orders~1chargebacks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_250","exampleIds":["paths/~1card-orders~1chargebacks/post/responses/200/content/application~1json/examples/Success","paths/~1card-orders~1chargebacks/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_250","exampleIds":["paths/~1card-orders~1chargebacks/post/responses/200/content/application~1json/examples/Success","paths/~1card-orders~1chargebacks/post/responses/200/content/application~1json/examples/Authentication failed"]}}}],"examples":[]}]}]}]},"httpPath":"/card-orders/chargebacks"},{"label":"PayPal disputes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/retrieve-apm-paypal-disputes","routeSlug":"/api/reports/retrieve-apm-paypal-disputes","metadata":{"seo":{"title":"PayPal disputes","description":"The report is crucial, offering detailed insights on each PayPal dispute and lifecycle stage. These details are essential for effective dispute management and enhancing customer satisfaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-apm-paypal-disputes","name":"PayPal disputes","isWebhook":false,"pointer":"/paths/~1apm-orders~1paypal-disputes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PayPal disputes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/reporting/operational-reports/paypal-disputes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is crucial, offering detailed insights on each PayPal dispute and lifecycle stage. These details are essential for effective "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispute management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and enhancing customer satisfaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This report uses the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created_at"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the default parameter for unloading data."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1apm-orders~1paypal-disputes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_251"}},"schemaId":"schema_251","pointer":"/paths/~1apm-orders~1paypal-disputes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/apm-orders/paypal-disputes","servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_251"}},"responseCodes":["200"],"pointer":"/apm-orders/paypal-disputes","href":"reports/retrieve-apm-paypal-disputes","openApiOperationId":"retrieve-apm-paypal-disputes","summary":"PayPal disputes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"schemaId":"schema_251","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_251"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_252","exampleIds":["paths/~1apm-orders~1paypal-disputes/post/responses/200/content/application~1json/examples/Success","paths/~1apm-orders~1paypal-disputes/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_252","exampleIds":["paths/~1apm-orders~1paypal-disputes/post/responses/200/content/application~1json/examples/Success","paths/~1apm-orders~1paypal-disputes/post/responses/200/content/application~1json/examples/Authentication failed"]}],"pointer":"/paths/~1apm-orders~1paypal-disputes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_252","exampleIds":["paths/~1apm-orders~1paypal-disputes/post/responses/200/content/application~1json/examples/Success","paths/~1apm-orders~1paypal-disputes/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_252","exampleIds":["paths/~1apm-orders~1paypal-disputes/post/responses/200/content/application~1json/examples/Success","paths/~1apm-orders~1paypal-disputes/post/responses/200/content/application~1json/examples/Authentication failed"]}}}],"examples":[]}]}]}]},"httpPath":"/apm-orders/paypal-disputes"},{"label":"Prevention alerts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/prevention-alerts-by-date","routeSlug":"/api/reports/prevention-alerts-by-date","metadata":{"seo":{"title":"Prevention alerts","description":"The report retrieves data to identify and resolve potential issues, thereby preventing the generation of alerts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"prevention-alerts-by-date","name":"Prevention alerts","isWebhook":false,"pointer":"/paths/~1prevention_alerts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prevention alerts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/reporting/operational-reports/prevention-alerts/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" retrieves data to identify and resolve potential issues, thereby preventing the generation of alerts."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This report uses the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created_at"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the default parameter for unloading data."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In a successful response, the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"report_url"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" field will contain a link to the file."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1prevention_alerts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_253"}},"schemaId":"schema_253","pointer":"/paths/~1prevention_alerts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/prevention_alerts","servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_253"}},"responseCodes":["200"],"pointer":"/prevention_alerts","href":"reports/prevention-alerts-by-date","openApiOperationId":"prevention-alerts-by-date","summary":"Prevention alerts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"schemaId":"schema_253","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_253"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254","exampleIds":["paths/~1prevention_alerts/post/responses/200/content/application~1json/examples/Success","paths/~1prevention_alerts/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_254","exampleIds":["paths/~1prevention_alerts/post/responses/200/content/application~1json/examples/Success","paths/~1prevention_alerts/post/responses/200/content/application~1json/examples/Authentication failed"]}],"pointer":"/paths/~1prevention_alerts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_254","exampleIds":["paths/~1prevention_alerts/post/responses/200/content/application~1json/examples/Success","paths/~1prevention_alerts/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254","exampleIds":["paths/~1prevention_alerts/post/responses/200/content/application~1json/examples/Success","paths/~1prevention_alerts/post/responses/200/content/application~1json/examples/Authentication failed"]}}}],"examples":[]}]}]}]},"httpPath":"/prevention_alerts"},{"label":"Download prevention alerts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/download-prevention-alerts","routeSlug":"/api/reports/download-prevention-alerts","metadata":{"seo":{"title":"Download prevention alerts","description":"The report offering detailed information on prevention alerts. It provides insights into each alert, including unique identifiers, alert types, amounts, outcomes, and the alert generation timeline."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download-prevention-alerts","name":"Download prevention alerts","isWebhook":false,"pointer":"/paths/~1prevention_alerts~1report~1{report_id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download prevention alerts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/reporting/operational-reports/prevention-alerts/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" offering detailed information on prevention alerts. It provides insights into each alert, including unique identifiers, alert types, amounts, outcomes, and the alert generation timeline."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The report unloads data based on the date range parameters that corresponds to the date the operation was executed."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In a successful response, you will be redirected to S3 to download the file."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_255","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique report identifier for download."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It follows the pattern [report_prefix] [date (yyMMdd)] [time (HHmmss)] [channel name]."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1prevention_alerts~1report~1{report_id}~1download/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1prevention_alerts~1report~1{report_id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/prevention_alerts/report/{report_id}/download","servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"example":"PREVENT_250702_140728_CHECKOUT","schemaId":"schema_255"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200","204","302","404","410"],"pointer":"/prevention_alerts/report/{report_id}/download","href":"reports/download-prevention-alerts","openApiOperationId":"download-prevention-alerts","summary":"Download prevention alerts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request received"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #1d8126","marginLeft":"20px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{"style":{"color":"#1d8126","marginLeft":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Response either redirects to S3 for download or returns error object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254","exampleIds":["paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]}},"schemaId":"schema_254","exampleIds":["paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]},{"code":"204","description":"Report is not ready"},{"code":"302","description":"Redirect to one-time S3 download report link"},{"code":"404","description":"Report not found"},{"code":"410","description":"Report unavailable (expired)"}],"pointer":"/paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_254","exampleIds":["paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254","exampleIds":["paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]}}},{"code":"204"},{"code":"302"},{"code":"404"},{"code":"410"}],"examples":[]}]}]}]},"httpPath":"/prevention_alerts/report/{report_id}/download"},{"label":"Card fraud alerts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/retrieve-card-fraud-alerts","routeSlug":"/api/reports/retrieve-card-fraud-alerts","metadata":{"seo":{"title":"Card fraud alerts","description":"The report is vital for merchants, providing detailed fraud-related information such as order IDs, amounts, and timings, along with specific fraud types and reason codes, crucial for swiftly identifying, analyzing, and formulating effective strategies to enhance transaction security."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-card-fraud-alerts","name":"Card fraud alerts","isWebhook":false,"pointer":"/paths/~1card-orders~1fraud-alerts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card fraud alerts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/reporting/operational-reports/card-fraud-alerts/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is vital for merchants, providing detailed "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/fraud/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fraud"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-related information such as order IDs, amounts, and timings, along with specific fraud types and reason codes, crucial for swiftly identifying, analyzing, and formulating effective strategies to enhance transaction security."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created_at"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the default parameter is used to unload fraud alert data. It specifies the exact time when a fraud alert was created."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1card-orders~1fraud-alerts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_251"}},"schemaId":"schema_251","pointer":"/paths/~1card-orders~1fraud-alerts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/card-orders/fraud-alerts","servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_251"}},"responseCodes":["200"],"pointer":"/card-orders/fraud-alerts","href":"reports/retrieve-card-fraud-alerts","openApiOperationId":"retrieve-card-fraud-alerts","summary":"Card fraud alerts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"schemaId":"schema_251","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_251"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_256","exampleIds":["paths/~1card-orders~1fraud-alerts/post/responses/200/content/application~1json/examples/Success","paths/~1card-orders~1fraud-alerts/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_256","exampleIds":["paths/~1card-orders~1fraud-alerts/post/responses/200/content/application~1json/examples/Success","paths/~1card-orders~1fraud-alerts/post/responses/200/content/application~1json/examples/Authentication failed"]}],"pointer":"/paths/~1card-orders~1fraud-alerts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_256","exampleIds":["paths/~1card-orders~1fraud-alerts/post/responses/200/content/application~1json/examples/Success","paths/~1card-orders~1fraud-alerts/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_256","exampleIds":["paths/~1card-orders~1fraud-alerts/post/responses/200/content/application~1json/examples/Success","paths/~1card-orders~1fraud-alerts/post/responses/200/content/application~1json/examples/Authentication failed"]}}}],"examples":[]}]}]}]},"httpPath":"/card-orders/fraud-alerts"},{"label":"Financial entries by date range","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/financial-entries-by-date","routeSlug":"/api/reports/financial-entries-by-date","metadata":{"seo":{"title":"Financial entries by date range","description":"In a successful response, you will receive a link to the file report_url."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"financial-entries-by-date","name":"Financial entries by date range","isWebhook":false,"pointer":"/paths/~1financial_entries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Financial entries by date range","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In a successful response, you will receive a link to the file "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/finance/financial-reports/financial-entries/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"financial data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" are in a CSV file, which can be found at the link. Data is available for export from the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"July 2022"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1financial_entries/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_257"}},"schemaId":"schema_257","pointer":"/paths/~1financial_entries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/financial_entries","servers":[{"url":"https://reports.solidgate.com/api/v1/finance","description":"Reports Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_257"}},"responseCodes":["200"],"pointer":"/financial_entries","href":"reports/financial-entries-by-date","openApiOperationId":"financial-entries-by-date","summary":"Financial entries by date range"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1/finance","description":"Reports Live API"}],"schemaId":"schema_257","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_257"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258","exampleIds":["paths/~1financial_entries/post/responses/200/content/application~1json/examples/Success","paths/~1financial_entries/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_258","exampleIds":["paths/~1financial_entries/post/responses/200/content/application~1json/examples/Success","paths/~1financial_entries/post/responses/200/content/application~1json/examples/Authentication failed"]}],"pointer":"/paths/~1financial_entries/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_258","exampleIds":["paths/~1financial_entries/post/responses/200/content/application~1json/examples/Success","paths/~1financial_entries/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258","exampleIds":["paths/~1financial_entries/post/responses/200/content/application~1json/examples/Success","paths/~1financial_entries/post/responses/200/content/application~1json/examples/Authentication failed"]}}}],"examples":[]}]}]}]},"httpPath":"/financial_entries"},{"label":"Download financial entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/download-financial-entries","routeSlug":"/api/reports/download-financial-entries","metadata":{"seo":{"title":"Download financial entries","description":"The report offers an extensive overview of financial transactions, detailing financial record IDs, order and transaction IDs, dates, amounts, currencies, payment methods, and geographical data essential for comprehensive financial analysis and management."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download-financial-entries","name":"Download financial entries","isWebhook":false,"pointer":"/paths/~1financial_entries~1report~1{report_id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download financial entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/finance/financial-reports/financial-entries/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" offers an extensive overview of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/finance/financial-reports/financial-entries/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"financial transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", detailing financial record IDs, order and transaction IDs, dates, amounts, currencies, payment methods, and geographical data essential for comprehensive financial analysis and management."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The report unloads data based on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created_at + 4 hours"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" parameter, which corresponds to the date the operation was executed."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In a successful response, you will be redirected to S3 to download the file."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_259","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique report identifier for download."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It follows the pattern [report_prefix] [date (yyMMdd)] [time (HHmmss)] [channel name]."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1financial_entries~1report~1{report_id}~1download/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1financial_entries~1report~1{report_id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/financial_entries/report/{report_id}/download","servers":[{"url":"https://reports.solidgate.com/api/v1/finance","description":"Reports Live API"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"example":"FIN_250702_140728_CHECKOUT","schemaId":"schema_259"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200","204","302","404","410"],"pointer":"/financial_entries/report/{report_id}/download","href":"reports/download-financial-entries","openApiOperationId":"download-financial-entries","summary":"Download financial entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1/finance","description":"Reports Live API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request received"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #1d8126","marginLeft":"20px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{"style":{"color":"#1d8126","marginLeft":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Response either redirects to S3 for download or returns error object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258","exampleIds":["paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]}},"schemaId":"schema_258","exampleIds":["paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]},{"code":"204","description":"Report is not ready"},{"code":"302","description":"Redirect to one-time S3 download report link"},{"code":"404","description":"Report not found"},{"code":"410","description":"Report unavailable (expired)"}],"pointer":"/paths/~1financial_entries~1report~1{report_id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_258","exampleIds":["paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258","exampleIds":["paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]}}},{"code":"204"},{"code":"302"},{"code":"404"},{"code":"410"}],"examples":[]}]}]}]},"httpPath":"/financial_entries/report/{report_id}/download"},{"label":"Routing events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/routing-events-by-date","routeSlug":"/api/reports/routing-events-by-date","metadata":{"seo":{"title":"Routing events","description":"The report provides a comprehensive view of routing decisions and execution flow for orders processed through routing configurations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"routing-events-by-date","name":"Routing events","isWebhook":false,"pointer":"/paths/~1routing~1events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Routing events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/orchestration/routing/manage-routing/#track-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides a comprehensive view of routing decisions and execution flow for orders processed through routing configurations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It captures the complete sequence of routing events for each transaction, including selected steps, skipped steps with reasons, 3DS decisions, and connector account details."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This report uses the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created_at"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the default parameter for unloading data. The date range between "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"date_from"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"date_to"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" must not exceed "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"36 days"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In a successful response, the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"report_url"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" field will contain a link to the file."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1routing~1events/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_253"}},"schemaId":"schema_253","pointer":"/paths/~1routing~1events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/routing/events","servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_253"}},"responseCodes":["200"],"pointer":"/routing/events","href":"reports/routing-events-by-date","openApiOperationId":"routing-events-by-date","summary":"Routing events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"schemaId":"schema_253","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_253"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_260","exampleIds":["paths/~1routing~1events/post/responses/200/content/application~1json/examples/Success","paths/~1routing~1events/post/responses/200/content/application~1json/examples/Authentication failed"]}},"schemaId":"schema_260","exampleIds":["paths/~1routing~1events/post/responses/200/content/application~1json/examples/Success","paths/~1routing~1events/post/responses/200/content/application~1json/examples/Authentication failed"]}],"pointer":"/paths/~1routing~1events/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_260","exampleIds":["paths/~1routing~1events/post/responses/200/content/application~1json/examples/Success","paths/~1routing~1events/post/responses/200/content/application~1json/examples/Authentication failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_260","exampleIds":["paths/~1routing~1events/post/responses/200/content/application~1json/examples/Success","paths/~1routing~1events/post/responses/200/content/application~1json/examples/Authentication failed"]}}}],"examples":[]}]}]}]},"httpPath":"/routing/events"},{"label":"Download routing events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/download-routing-events","routeSlug":"/api/reports/download-routing-events","metadata":{"seo":{"title":"Download routing events","description":"The report offers detailed information on routing events. It provides insights into each event, including unique identifiers, configuration and version, route and step details, 3DS decisions, and connector account selected for processing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download-routing-events","name":"Download routing events","isWebhook":false,"pointer":"/paths/~1routing~1events~1report~1{report_id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download routing events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/orchestration/routing/manage-routing/#track-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" offers detailed information on routing events. It provides insights into each event, including unique identifiers, configuration and version, route and step details, 3DS decisions, and connector account selected for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The report unloads data based on the date range parameters that corresponds to the date the operation was executed."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In a successful response, you will be redirected to S3 to download the file."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_261","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique report identifier for download."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It follows the pattern [report_prefix] [date (yyMMdd)] [time (HHmmss)] [channel name]."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1routing~1events~1report~1{report_id}~1download/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1routing~1events~1report~1{report_id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/routing/events/report/{report_id}/download","servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"example":"ROUTING_250702_140728_CHECKOUT","schemaId":"schema_261"}],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"responseCodes":["200","204","302","404","410"],"pointer":"/routing/events/report/{report_id}/download","href":"reports/download-routing-events","openApiOperationId":"download-routing-events","summary":"Download routing events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://reports.solidgate.com/api/v1","description":"Reports Live API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request received"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #1d8126","marginLeft":"20px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{"style":{"color":"#1d8126","marginLeft":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Response either redirects to S3 for download or returns error object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_260","exampleIds":["paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]}},"schemaId":"schema_260","exampleIds":["paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]},{"code":"204","description":"Report is not ready"},{"code":"302","description":"Redirect to one-time S3 download report link"},{"code":"404","description":"Report not found"},{"code":"410","description":"Report unavailable (expired)"}],"pointer":"/paths/~1routing~1events~1report~1{report_id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_260","exampleIds":["paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_260","exampleIds":["paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success","paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed","paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"]}}},{"code":"204"},{"code":"302"},{"code":"404"},{"code":"410"}],"examples":[]}]}]}]},"httpPath":"/routing/events/report/{report_id}/download"}],"content":{"contentType":"group","meta":{"name":"Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solidgate API for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/reporting/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows merchants to securely access transaction data and generate customized reports for analyzing and tracking the performance of their payment operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With Solidgate’s reconciliation functionality, merchants can track cash daily, identify fund flow gaps, gain complete transaction lifecycle visibility, implement strong financial controls, and establish scalable financial processes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Solidgate data comes with a 60-minute delay, thus it is not recommended for real-time analysis."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Please note that reports may be inaccessible for about 30 minutes on Wednesdays at 5:00 PM (UTC) due to scheduled external maintenances. Once complete, all reports will be available with data preserved."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/card-orders","summary":"Card orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/retrieve-card-orders","deprecated":false},{"title":"/apm-orders","summary":"APM orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/retrieve-apm-orders","deprecated":false},{"title":"/subscriptions","summary":"Subscriptions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/retrieve-subscriptions","deprecated":false},{"title":"/card-orders/chargebacks","summary":"Chargebacks","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/retrieve-card-chargebacks","deprecated":false},{"title":"/apm-orders/paypal-disputes","summary":"PayPal disputes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/retrieve-apm-paypal-disputes","deprecated":false},{"title":"/prevention_alerts","summary":"Prevention alerts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/prevention-alerts-by-date","deprecated":false},{"title":"/prevention_alerts/report/{report_id}/download","summary":"Download prevention alerts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/download-prevention-alerts","deprecated":false},{"title":"/card-orders/fraud-alerts","summary":"Card fraud alerts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/retrieve-card-fraud-alerts","deprecated":false},{"title":"/financial_entries","summary":"Financial entries by date range","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/financial-entries-by-date","deprecated":false},{"title":"/financial_entries/report/{report_id}/download","summary":"Download financial entries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/download-financial-entries","deprecated":false},{"title":"/routing/events","summary":"Routing events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/routing-events-by-date","deprecated":false},{"title":"/routing/events/report/{report_id}/download","summary":"Download routing events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/download-routing-events","deprecated":false}]}]}]}]}},{"type":"separator","label":"Files","content":null},{"type":"group","label":"Files upload","link":"/api/files-upload","routeSlug":"/api/files-upload","items":[{"label":"Create file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files-upload/create-upload-url","routeSlug":"/api/files-upload/create-upload-url","metadata":{"seo":{"title":"Create file","description":"This method allows to create a file upload request by generating a unique file_id to reference the file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-upload-url","name":"Create file","isWebhook":false,"pointer":"/paths/~1file~1get-upload-url/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method allows to create a file upload request by generating a unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reference the file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This file can be used for various purposes such as evidence for dispute representment, compliance checks, or other necessary documentation uploads."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MerchantID","scopes":[],"type":"apiKey","in":"header","paramName":"Merchant id"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"merchant","in":"header","schemaId":"schema_170","required":true},{"name":"signature","in":"header","schemaId":"schema_171","required":true}],"pointer":"/paths/~1file~1get-upload-url/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestFilesCreateFileUpload"}},"schemaId":"components/schemas/RequestFilesCreateFileUpload","pointer":"/paths/~1file~1get-upload-url/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/file/get-upload-url","servers":[{"url":"https://api.solidgate.com/api/v1","description":"File upload Live API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"merchant","in":"header","required":true,"example":"api_pk_7b197...ba108f842","schemaId":"components/schemas/HeaderMainMerchant"},{"name":"signature","in":"header","required":true,"example":"M2E3OTkyNzcz...xMmExODI4","schemaId":"components/schemas/HeaderMainSignature"}],"cookie":[]},"security":[{"schemes":[{"id":"MerchantID","type":"apiKey","name":"Merchant id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestFilesCreateFileUpload"}},"responseCodes":["200"],"pointer":"/file/get-upload-url","href":"files-upload/create-upload-url","openApiOperationId":"create-upload-url","summary":"Create file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.solidgate.com/api/v1","description":"File upload Live API"}],"schemaId":"components/schemas/RequestFilesCreateFileUpload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestFilesCreateFileUpload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request received","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_262","exampleIds":["paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Success","paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Error 2.01 Validation error"]}},"schemaId":"schema_262","exampleIds":["paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Success","paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Error 2.01 Validation error"]}],"pointer":"/paths/~1file~1get-upload-url/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_262","exampleIds":["paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Success","paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Error 2.01 Validation error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_262","exampleIds":["paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Success","paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Authentication failed","paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Error 2.01 Validation error"]}}}],"examples":[]}]}]}]},"httpPath":"/file/get-upload-url"}],"content":{"contentType":"group","meta":{"name":"Files upload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Files upload","showPageActions":true},{"nodeType":"markdoc","content":"Solidgate API for file uploads enables to securely upload files to the system, such as evidence for chargeback disputes or documents required for verification purposes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/file/get-upload-url","summary":"Create file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/files-upload/create-upload-url","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/HeaderMainMerchant":{"id":"components/schemas/HeaderMainMerchant","kind":"json-schema","title":"HeaderMainMerchant","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/access-to-api/#retrieve-your-credentials","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided upon registration and must be shared for identification purposes."},"children":[]}]}]}],"example":"api_pk_7b197...ba108f842"}},"components/schemas/HeaderMainSignature":{"id":"components/schemas/HeaderMainSignature","kind":"json-schema","title":"HeaderMainSignature","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/access-to-api/#generate-signature","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"signature"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that allows verification of merchant authenticity on the payment gateway server."},"children":[]}]}]}],"example":"M2E3OTkyNzcz...xMmExODI4"}},"components/schemas/SchemaCardsDynamicDescriptor":{"id":"components/schemas/SchemaCardsDynamicDescriptor","kind":"json-schema","title":"DynamicDescriptor","data":{"title":"DynamicDescriptor","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/billing-descriptor/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dynamic suffix"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appended to the statement descriptor shown on the cardholder's bank statement."},"children":[]}]}]}],"required":["suffix"],"properties":{"suffix":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic part of the billing descriptor that appears on the cardholder's bank statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Must match ASCII alphanumeric characters, punctuation, and spaces. Must not contain the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"^"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" symbol."},"children":[]}]}]}],"minLength":1,"maxLength":18,"pattern":"^[\\x20-\\x5D\\x5F-\\x7E]+$","example":"PRODUCTX"}}}},"components/schemas/SchemaCheckoutSolutionsPaymentTypeData":{"id":"components/schemas/SchemaCheckoutSolutionsPaymentTypeData","kind":"json-schema","title":"Payment type data","data":{"title":"Payment type data","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the customer later enters a value on the page, that value takes precedence over the data sent in this object."},"children":[]}]}]}],"properties":{"klarna_network_session_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Klarna Web SDK session token."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for Klarna boost features like Express Checkout, On-Site Messaging, and Sign in with Klarna. Enables session continuity and pre-filled customer details."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Obtain the token from the Klarna Web SDK and always use the latest value. Never reuse a consumed token."},"children":[]}]}]}],"maxLength":10240},"klarna_network_data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Klarna Network Data (KND). Structured JSON pass-through carrying Klarna payment context across the payment lifecycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to include supplementary purchase data, for example order line items, as described in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.klarna.com/acquirer/solidgate/get-started/optimize-klarna-transactions/how-to-share-klarna-network-data/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"how to send Klarna Network Data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":10240},"sweden_pin":{"type":"string","description":"Swedish personal identity number for customers in Sweden.","pattern":"^[0-9]{8}-[0-9]{4}$","maxLength":13,"example":"19811228-9874"},"norway_nin":{"type":"string","description":"Norwegian national identity number for customers in Norway.","pattern":"^[0-9]{11}$","maxLength":11,"example":"01017012345"},"italy_cf":{"type":"string","description":"Italian tax code, codice fiscale, for customers in Italy.","pattern":"^[A-Z]{6}[0-9]{2}[ABCDEHLMPRST][0-9]{2}[A-Z][0-9]{3}[A-Z]$","maxLength":16,"example":"RSSMRA85M01H501Z"},"finland_hetu":{"type":"string","description":"Finnish personal identity code for customers in Finland.","pattern":"^[0-9]{6}[A+-][0-9]{3}[0-9A-Z]$","maxLength":11,"example":"131052-308T"},"spain_dni":{"type":"string","description":"Spanish national ID, DNI, for customers in Spain.","pattern":"^[0-9]{8}[A-Z]$","maxLength":9,"example":"12345678Z"},"denmark_cpr":{"type":"string","description":"Danish civil registration number for customers in Denmark.","pattern":"^[0-9]{6}-[0-9]{4}$","maxLength":11,"example":"120578-1234"},"usa_ssn":{"type":"string","description":"US Social Security Number for customers in the United States.","pattern":"^([0-9]{3}-[0-9]{2}-[0-9]{4}|[0-9]{9})$","maxLength":11,"example":"123-45-6789"}}}},"components/schemas/RequestCheckoutSolutionsCreatePage":{"id":"components/schemas/RequestCheckoutSolutionsCreatePage","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","required":["order","page_customization"],"properties":{"order":{"type":"object","description":"Information required to create an order.","required":["order_id","amount","currency","order_description","type"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used later to find this payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (cents for euros)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"However, the value 0 is valid only for a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow. In cases where the amount received from APM systems is 0, only PayPal is queried for processing."},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the product price currency."},"children":[]}]}]}],"minLength":3,"maxLength":3},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"properties":{"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment type for future usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"alipay"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"bizum"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"mbway"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"wechatpay"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["one-time","unscheduled"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"final"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - standard authorization, no increments allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"estimated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - initial authorization with possible amount changes"},"children":[]}]}]}]}]},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]}],"default":false},"google_pay_allowed_auth_methods":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of allowed Google Pay authorization methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAN_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this authentication method is associated with payment cards stored on file with the user’s Google Account. Returned payment data includes primary account number (PAN) with the expiration month and the expiration year."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRYPTOGRAM_3DS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this authentication method is associated with cards stored as Android device tokens. Returned payment data includes a 3D Secure (3DS) cryptogram generated on the device."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The capability to transmit only "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PAN_ONLY"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CRYPTOGRAM_3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is also available, and such transmission will work for both one-time payments and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email address."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Can be used for sending receipts and notifications; if not provided, the field still appears on the payment page with a note \"For receipts and notifications\"."},"children":[]}]}]}],"maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"address":{"type":"string","description":"First line of the billing address.","maxLength":100}}},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"payment_type_data":{"$ref":"#/components/schemas/SchemaCheckoutSolutionsPaymentTypeData"},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment page language that customers can change to English."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is also used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"enum":["cs","da","de","el","en","es","fi","fr","it","nl","no","pl","pt","ro","sk","sv","uk"]},"website":{"type":"string","description":"Website from which the transaction took place.","maxLength":255},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}},"page_customization":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information required to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customize"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the payment page display."},"children":[]}]}]}],"required":["public_name"],"properties":{"public_name":{"type":"string","maxLength":46,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shop name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is visible to customers on the payment page."},"children":[]}]}]}]},"order_title":{"type":"string","maxLength":100,"description":"Names of goods or services you sell are visible to customers on the payment page."},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":401},"payment_methods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"string"}},"button_font_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the font on the Pay Button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use HEX format."},"children":[]}]}]}]},"button_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the Pay Button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use HEX format."},"children":[]}]}]}]},"font_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Font name on the payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use the Google Font name."},"children":[]}]}]}],"maxLength":255},"is_cardholder_visible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display the field cardholder on the payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the field is accepted as true, it will be displayed."},"children":[]}]}]}]},"terms_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for the merchant Terms & Conditions will be attached to the checkbox."},"children":[]}]}]}],"maxLength":1000},"back_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the customer should be redirected in case of clicks the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Back"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Passing this parameter will add a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Back"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" button on your payment and status pages."},"children":[]}]}]}],"maxLength":1000}}}}}},"components/schemas/RequestCheckoutSolutionsCreateSubscriptionPaymentPage":{"id":"components/schemas/RequestCheckoutSolutionsCreateSubscriptionPaymentPage","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","type":"object","required":["order","page_customization"],"properties":{"order":{"type":"object","description":"Information required to create an order.","required":["order_id","product_id","order_description","type","customer_account_id"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used later to find this payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier of the subscription."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"product_price_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_price_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow and to ensure correct pricing, specifically for multi-currency products."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"To get "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_price_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/products-and-prices/get-product-prices","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"get product prices"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request."},"children":[]}]}]}],"type":"string","format":"uuid"},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of retry attempts for the subscription payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use it for analytics and conversion tuning purposes."},"children":[]}]}]}],"minimum":0},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]}],"default":false},"google_pay_allowed_auth_methods":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of allowed Google Pay authorization methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAN_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this authentication method is associated with payment cards stored on file with the user’s Google Account. Returned payment data includes primary account number (PAN) with the expiration month and the expiration year."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRYPTOGRAM_3DS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this authentication method is associated with cards stored as Android device tokens. Returned payment data includes a 3D Secure (3DS) cryptogram generated on the device."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The capability to transmit only "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PAN_ONLY"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CRYPTOGRAM_3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is also available, and such transmission will work for both one-time payments and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email address."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Can be used for sending receipts and notifications; if not provided, the field still appears on the payment page with a note \"For receipts and notifications\"."},"children":[]}]}]}],"maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"address":{"type":"string","description":"First line of the billing address.","maxLength":100}}},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's registration country in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-3166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alpha-3 country code format."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment page language that customers can change to English."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is also used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"enum":["cs","da","de","el","en","es","fi","fr","it","nl","no","pl","pt","ro","sk","sv","uk"]},"website":{"type":"string","description":"Website from which the transaction took place.","maxLength":255},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}},"page_customization":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information required to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customize"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the payment page display."},"children":[]}]}]}],"required":["public_name"],"properties":{"public_name":{"type":"string","maxLength":46,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shop name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is visible to customers on the payment page."},"children":[]}]}]}]},"order_title":{"type":"string","maxLength":100,"description":"Names of goods or services you sell are visible to customers on the payment page."},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":401},"payment_methods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"string"}},"button_font_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the font on the Pay Button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use HEX format."},"children":[]}]}]}]},"button_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the Pay Button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use HEX format."},"children":[]}]}]}]},"font_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Font name on the payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use the Google Font name."},"children":[]}]}]}],"maxLength":255},"is_cardholder_visible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display the field cardholder on the payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the field is accepted as true, it will be displayed."},"children":[]}]}]}]},"terms_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for the merchant Terms & Conditions will be attached to the checkbox."},"children":[]}]}]}],"maxLength":1000},"back_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the customer should be redirected in case of clicks the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Back"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Passing this parameter will add a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Back"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" button on your payment and status pages."},"children":[]}]}]}],"maxLength":1000}}}}}},"components/schemas/RequestCheckoutSolutionsCreateInvoicePaymentPage":{"id":"components/schemas/RequestCheckoutSolutionsCreateInvoicePaymentPage","kind":"json-schema","title":"Invoice payment","data":{"title":"Invoice payment","type":"object","required":["order","page_customization"],"properties":{"order":{"type":"object","description":"Information required to create an order.","required":["order_id","invoice_id"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used later to find this payment.","maxLength":255},"invoice_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated invoice identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" are derived from the invoice."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Retrieve invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/v2/invoices","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invoices"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" API V2."},"children":[]}]}]}],"maxLength":100,"example":"inv_01KPWT0K1PQWEYYRT7J1H3NC85"},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"properties":{"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment type for future usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"alipay"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"bizum"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"mbway"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"wechatpay"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["one-time","unscheduled"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order.","maxLength":255},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"final"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - standard authorization, no increments allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"estimated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - initial authorization with possible amount changes"},"children":[]}]}]}]}]},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]}],"default":false},"google_pay_allowed_auth_methods":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of allowed Google Pay authorization methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAN_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this authentication method is associated with payment cards stored on file with the user’s Google Account. Returned payment data includes primary account number (PAN) with the expiration month and the expiration year."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRYPTOGRAM_3DS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this authentication method is associated with cards stored as Android device tokens. Returned payment data includes a 3D Secure (3DS) cryptogram generated on the device."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The capability to transmit only "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PAN_ONLY"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CRYPTOGRAM_3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is also available, and such transmission will work for both one-time payments and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email address."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Can be used for sending receipts and notifications; if not provided, the field still appears on the payment page with a note \"For receipts and notifications\"."},"children":[]}]}]}],"maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"address":{"type":"string","description":"First line of the billing address.","maxLength":100}}},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment page language that customers can change to English."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is also used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"enum":["cs","da","de","el","en","es","fi","fr","it","nl","no","pl","pt","ro","sk","sv","uk"]},"website":{"type":"string","description":"Website from which the transaction took place.","maxLength":255},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}},"page_customization":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information required to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customize"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the payment page display."},"children":[]}]}]}],"required":["public_name"],"properties":{"public_name":{"type":"string","maxLength":46,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shop name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is visible to customers on the payment page."},"children":[]}]}]}]},"order_title":{"type":"string","maxLength":100,"description":"Names of goods or services you sell are visible to customers on the payment page."},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":401},"payment_methods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"string"}},"button_font_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the font on the Pay Button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use HEX format."},"children":[]}]}]}]},"button_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the Pay Button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use HEX format."},"children":[]}]}]}]},"font_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Font name on the payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use the Google Font name."},"children":[]}]}]}],"maxLength":255},"is_cardholder_visible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display the field cardholder on the payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the field is accepted as true, it will be displayed."},"children":[]}]}]}]},"terms_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for the merchant Terms & Conditions will be attached to the checkbox."},"children":[]}]}]}],"maxLength":1000},"back_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the customer should be redirected in case of clicks the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Back"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Passing this parameter will add a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Back"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" button on your payment and status pages."},"children":[]}]}]}],"maxLength":1000}}}}}},"components/schemas/ResponseCheckoutSolutionsPage":{"id":"components/schemas/ResponseCheckoutSolutionsPage","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"url":{"type":"string","description":"Specific URL where the customer should be directed to complete their transaction.","example":"https://payment-page.solidgate.com/VxKnj3D"},"id":{"type":"string","description":"Unique payment page identifier.","example":"VxKnj3D"},"guid":{"type":"string","description":"Unique payment session identifier.","deprecated":true}},"required":["url","id"]}},"components/schemas/ResponseCheckoutSolutionsAuthenticationFailed":{"id":"components/schemas/ResponseCheckoutSolutionsAuthenticationFailed","kind":"json-schema","title":"Authentication failed","data":{"title":"Authentication failed","type":"object","properties":{"error":{"description":"Error object.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#101-authentication-failed","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" due to invalid credentials."},"children":[]}]}]}],"default":1.01,"example":"1.01"},"message":{"type":"array","description":"Array of error messages applied to the decline payment.","items":{"example":"Authentication failed"}}},"required":["code","message"]}},"required":["error"]}},"components/schemas/ResponseCheckoutSolutionsError":{"id":"components/schemas/ResponseCheckoutSolutionsError","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"error":{"description":"Error object.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2.01"},"message":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object provide details about the error or status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Contain key-value pairs explaining the issue in more detail."},"children":[]}]}]}]}},"required":["code","message"]}},"required":["error"]}},"components/schemas/RequestCheckoutSolutionsDeactivatePage":{"id":"components/schemas/RequestCheckoutSolutionsDeactivatePage","kind":"json-schema","title":"Deactivate payment page","data":{"title":"Deactivate payment page","type":"object","required":["id"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique payment page identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Can be found at the end of the payment page URL."},"children":[]}]}]}],"example":"VxKnj3D"}}}},"components/schemas/RequestCheckoutSolutionsCreateLink":{"id":"components/schemas/RequestCheckoutSolutionsCreateLink","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","required":["order","page_customization"],"properties":{"order":{"type":"object","description":"Information required to create an order.","required":["amount","currency","type"],"properties":{"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (cents for euros)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"However, the value 0 is valid only for a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow."},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the product price currency."},"children":[]}]}]}],"minLength":3,"maxLength":3},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"properties":{"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment type for future usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"alipay"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"bizum"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"mbway"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"wechatpay"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["one-time","unscheduled"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"final"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - standard authorization, no increments allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"estimated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - initial authorization with possible amount changes"},"children":[]}]}]}]}]},"google_pay_allowed_auth_methods":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of allowed Google Pay authorization methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAN_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this authentication method is associated with payment cards stored on file with the user’s Google Account. Returned payment data includes primary account number (PAN) with the expiration month and the expiration year."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRYPTOGRAM_3DS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this authentication method is associated with cards stored as Android device tokens. Returned payment data includes a 3D Secure (3DS) cryptogram generated on the device."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The capability to transmit only "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PAN_ONLY"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CRYPTOGRAM_3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is also available, and such transmission will work for both one-time payments and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"payment_type_data":{"$ref":"#/components/schemas/SchemaCheckoutSolutionsPaymentTypeData"},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment link language that customers can change to English."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is also used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"enum":["cs","da","de","el","en","es","fi","fr","it","nl","no","pl","pt","ro","sk","sv","uk"]},"website":{"type":"string","description":"Website from which the transaction took place.","maxLength":255},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for browser redirect after a failed payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided if you want to use the user's card details on a failed payment  for retry logic."},"children":[]}]}]}],"maxLength":255}}},"page_customization":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information required to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customize"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the payment page display."},"children":[]}]}]}],"required":["public_name"],"properties":{"public_name":{"type":"string","maxLength":46,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shop name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is visible to customers on the payment page."},"children":[]}]}]}]},"order_title":{"type":"string","maxLength":100,"description":"Names of goods or services you sell are visible to customers on the payment page."},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":401},"payment_methods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"string"}},"button_font_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the font on the Pay Button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use HEX format."},"children":[]}]}]}]},"button_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the Pay Button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use HEX format."},"children":[]}]}]}]},"font_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Font name on the payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use the Google Font name."},"children":[]}]}]}],"maxLength":255},"is_cardholder_visible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display the field cardholder on the payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the field is accepted as true, it will be displayed."},"children":[]}]}]}]},"terms_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for the merchant Terms & Conditions will be attached to the checkbox."},"children":[]}]}]}],"maxLength":1000},"back_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the customer should be redirected in case of clicks the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Back"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Passing this parameter will add a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Back"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" button on your payment and status pages."},"children":[]}]}]}],"maxLength":1000}}},"configuration":{"type":"object","description":"Configuration settings for the payment link.","properties":{"usage_mode":{"type":"string","default":"reusable","enum":["reusable","single_use"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the payment link usage mode."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reusable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows multiple successful payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single_use"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only one successful payment allowed per link"},"children":[]}]}]}]}]},"amount_setter":{"type":"string","default":"merchant","enum":["merchant","payer"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the method for setting the payment amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the merchant sets the amount directly"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the amount is determined based on payer input"},"children":[]}]}]}]}]}}}}}},"components/schemas/RequestCheckoutSolutionsCreateSubscriptionPaymentLink":{"id":"components/schemas/RequestCheckoutSolutionsCreateSubscriptionPaymentLink","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","type":"object","required":["order","page_customization"],"properties":{"order":{"type":"object","description":"Information required to create an order.","required":["product_id","type"],"properties":{"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier of the subscription."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"product_price_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_price_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow and to ensure correct pricing, specifically for multi-currency products."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"To get "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_price_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/products-and-prices/get-product-prices","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"get product prices"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request."},"children":[]}]}]}],"type":"string","format":"uuid"},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"google_pay_allowed_auth_methods":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of allowed Google Pay authorization methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAN_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this authentication method is associated with payment cards stored on file with the user’s Google Account. Returned payment data includes primary account number (PAN) with the expiration month and the expiration year."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRYPTOGRAM_3DS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this authentication method is associated with cards stored as Android device tokens. Returned payment data includes a 3D Secure (3DS) cryptogram generated on the device."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The capability to transmit only "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PAN_ONLY"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CRYPTOGRAM_3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is also available, and such transmission will work for both one-time payments and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment link language that customers can change to English."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is also used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"enum":["cs","da","de","el","en","es","fi","fr","it","nl","no","pl","pt","ro","sk","sv","uk"]},"website":{"type":"string","description":"Website from which the transaction took place.","maxLength":255},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for browser redirect after a failed payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided if you want to use the user's card details on a failed payment  for retry logic."},"children":[]}]}]}],"maxLength":255}}},"page_customization":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information required to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customize"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the payment page display."},"children":[]}]}]}],"required":["public_name"],"properties":{"public_name":{"type":"string","maxLength":46,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shop name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is visible to customers on the payment page."},"children":[]}]}]}]},"order_title":{"type":"string","maxLength":100,"description":"Names of goods or services you sell are visible to customers on the payment page."},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":401},"payment_methods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"string"}},"button_font_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the font on the Pay Button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use HEX format."},"children":[]}]}]}]},"button_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the Pay Button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use HEX format."},"children":[]}]}]}]},"font_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Font name on the payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use the Google Font name."},"children":[]}]}]}],"maxLength":255},"is_cardholder_visible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display the field cardholder on the payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the field is accepted as true, it will be displayed."},"children":[]}]}]}]},"terms_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for the merchant Terms & Conditions will be attached to the checkbox."},"children":[]}]}]}],"maxLength":1000},"back_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RL where the customer should be redirected in case of clicks the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Back"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Passing this parameter will add a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Back"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" button on your payment and status pages."},"children":[]}]}]}],"maxLength":1000}}}}}},"components/schemas/RequestCheckoutSolutionsCreateInvoicePaymentLink":{"id":"components/schemas/RequestCheckoutSolutionsCreateInvoicePaymentLink","kind":"json-schema","title":"Invoice payment","data":{"title":"Invoice payment","type":"object","required":["order","page_customization"],"properties":{"order":{"type":"object","description":"Information required to create an order.","required":["invoice_id"],"properties":{"invoice_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated invoice identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" are derived from the invoice."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Retrieve invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/v2/invoices","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invoices"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" API V2."},"children":[]}]}]}],"maxLength":100,"example":"inv_01KPWT0K1PQWEYYRT7J1H3NC85"},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"properties":{"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment type for future usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"alipay"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"bizum"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"mbway"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"wechatpay"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["one-time","unscheduled"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"final"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - standard authorization, no increments allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"estimated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - initial authorization with possible amount changes"},"children":[]}]}]}]}]},"google_pay_allowed_auth_methods":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of allowed Google Pay authorization methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAN_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this authentication method is associated with payment cards stored on file with the user’s Google Account. Returned payment data includes primary account number (PAN) with the expiration month and the expiration year."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRYPTOGRAM_3DS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this authentication method is associated with cards stored as Android device tokens. Returned payment data includes a 3D Secure (3DS) cryptogram generated on the device."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The capability to transmit only "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PAN_ONLY"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CRYPTOGRAM_3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is also available, and such transmission will work for both one-time payments and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment link language that customers can change to English."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is also used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"enum":["cs","da","de","el","en","es","fi","fr","it","nl","no","pl","pt","ro","sk","sv","uk"]},"website":{"type":"string","description":"Website from which the transaction took place.","maxLength":255},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for browser redirect after a failed payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided if you want to use the user's card details on a failed payment  for retry logic."},"children":[]}]}]}],"maxLength":255}}},"page_customization":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information required to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customize"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the payment page display."},"children":[]}]}]}],"required":["public_name"],"properties":{"public_name":{"type":"string","maxLength":46,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shop name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is visible to customers on the payment page."},"children":[]}]}]}]},"order_title":{"type":"string","maxLength":100,"description":"Names of goods or services you sell are visible to customers on the payment page."},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":401},"payment_methods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"string"}},"button_font_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the font on the Pay Button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use HEX format."},"children":[]}]}]}]},"button_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the Pay Button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use HEX format."},"children":[]}]}]}]},"font_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Font name on the payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to use the Google Font name."},"children":[]}]}]}],"maxLength":255},"is_cardholder_visible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display the field cardholder on the payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the field is accepted as true, it will be displayed."},"children":[]}]}]}]},"terms_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for the merchant Terms & Conditions will be attached to the checkbox."},"children":[]}]}]}],"maxLength":1000},"back_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the customer should be redirected in case of clicks the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Back"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Passing this parameter will add a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Back"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" button on your payment and status pages."},"children":[]}]}]}],"maxLength":1000}}},"configuration":{"type":"object","description":"Configuration settings for the payment link.","properties":{"usage_mode":{"type":"string","default":"reusable","enum":["reusable","single_use"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the payment link usage mode."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reusable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows multiple successful payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single_use"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only one successful payment allowed per link"},"children":[]}]}]}]}]},"amount_setter":{"type":"string","default":"merchant","enum":["merchant","payer"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the method for setting the payment amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the merchant sets the amount directly"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the amount is determined based on payer input"},"children":[]}]}]}]}]}}}}}},"components/schemas/ResponseCheckoutSolutionsLink":{"id":"components/schemas/ResponseCheckoutSolutionsLink","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"url":{"type":"string","description":"Specific URL where the customer should be directed to complete their transaction.","example":"https://payment-page.solidgate.com/link/Q6J3212g7K"},"id":{"type":"string","description":"Unique payment link identifier.","example":"Q6J3212g7K"}},"required":["url","id"]}},"components/schemas/RequestCheckoutSolutionsDeactivateLink":{"id":"components/schemas/RequestCheckoutSolutionsDeactivateLink","kind":"json-schema","title":"Deactivate payment link","data":{"title":"Deactivate payment link","type":"object","required":["id"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique payment link identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Can be found at the end of the payment link URL."},"children":[]}]}]}],"example":"Q6J3212g7K"}}}},"components/schemas/SchemaCardsExternalMpiDsVersion":{"id":"components/schemas/SchemaCardsExternalMpiDsVersion","kind":"json-schema","title":"SchemaCardsExternalMpiDsVersion","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required information to process a payment that has been 3DS authenticated using a third-party merchant plug-in (MPI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide this data, as it reduces the risk of transaction failures."},"children":[]}]}]}],"required":["three_ds_version","eci","cryptogram","ds_transaction_id","authentication_response","three_ds_flow"],"properties":{"three_ds_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the version of 3D Secure used for authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"2.X.X"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" pattern."},"children":[]}]}]}],"enum":["2.1.0","2.2.0"]},"three_ds_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the authentication "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/3ds-verification/#mpi-data-insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["frictionless","challenge","none"]},"acs_challenge_mandated_ind":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the issuer preference for whether or not a 3DS challenge should be performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The issuer has the final say on whether or not the customer receives the challenge."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible values as they are defined in 3D Secure 2 protocols."},"children":[]}]}]}],"minLength":1,"maxLength":1},"transaction_challenge_exemption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Control Server (ACS) applies an exemption to authenticate the transaction without requesting a challenge."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible values as they are defined in 3D Secure 2 protocols."},"children":[]}]}]}],"minLength":2,"maxLength":2},"challenge_cancel_ind":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible values as defined in 3D Secure 2 protocols."},"children":[]}]}]}],"minLength":2,"maxLength":2},"eci":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic Commerce Indicator ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") level associated with the 3D Secure enrollment result."},"children":[]}]}]}],"minLength":1,"maxLength":2},"cryptogram":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64 encoded cardholder authentication value (20 bytes in decoded form) used for validating the authentication result."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In 3D Secure 2 this is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticationValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in the ARes (if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frictionless flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or the RReq (if a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"challenge flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"minLength":1,"maxLength":64},"cryptogram_algorithm":{"type":"string","description":"Algorithm used by Issuer Access Control Server (ACS) to calculate the cryptogram.","minLength":1,"maxLength":1},"authentication_response":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/3ds-verification/#mpi-data-insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned from the card Issuer’s Access Control Server (ACS) or Scheme Directory Server (DS)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" received in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the ARes (Authentication Response) message in case of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frictionless flow"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the last CRes (Challenge Response) message in case of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"challenge flow"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or in the RReq (Results Request) message sent after the cardholder completes the challenge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the transaction was frictionless, there are no CRes or RReq messages."},"children":[]}]}]}],"enum":["Y","A"]},"ds_transaction_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the reason for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in 3D Secure 2."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible values as defined in 3D Secure 2 protocols."},"children":[]}]}]}],"minLength":2,"maxLength":2},"ds_transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction identifier assigned by the Directory Server (DS) to identify a single transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"eci"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" values "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"01"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"02"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"05"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"06"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" when 3DS2 is used."},"children":[]}]}]}],"minLength":1,"maxLength":100},"three_ds_server_transaction_id":{"type":"string","description":"Identifier assigned by the 3D Secure 2 server to a single transaction.","minLength":1,"maxLength":100},"acs_transaction_id":{"type":"string","description":"Transaction identifier assigned by the ACS to identify a single transaction.","minLength":36,"maxLength":36,"format":"uuid"},"authentication_method":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the authentication "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/3ds-verification/#mpi-data-insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the issuer will use to challenge the cardholder in the ARes message, or those used by the ACS in the RReq message."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"12"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (decoupled) is not supported."},"children":[]}]}]}],"items":{"type":"string","minLength":2,"maxLength":2}},"authentication_timestamp":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication datetime in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minLength":6,"maxLength":25}}}},"components/schemas/SchemaCardsIndustryDataAirline":{"id":"components/schemas/SchemaCardsIndustryDataAirline","kind":"json-schema","title":"SchemaCardsIndustryDataAirline","data":{"title":"SchemaCardsIndustryDataAirline","type":"object","required":["type","airline"],"properties":{"type":{"type":"string","description":"Type of entity used to identify the classification of the data being provided.","enum":["airline"]},"airline":{"type":"array","minItems":1,"description":"Airline-related details.","items":{"type":"object","required":["airline_code","airline_designator_code","airline_name","document_type","travel_agency_code","ticket","passenger","flight_legs"],"additionalProperties":false,"properties":{"airline_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.iata.org/en/services/codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IATA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 3-digit accounting code that identifies the carrier."},"children":[]}]}]}],"maxLength":3,"minLength":3},"airline_designator_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.iata.org/en/services/codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IATA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 2-letter airline designator that identifies the carrier."},"children":[]}]}]}]},"airline_name":{"type":"string","description":"Name of the airline, as displayed on the bill.","maxLength":255},"boarding_fee":{"type":"string","description":"Amount charged for boarding the plane, in minor units.","minLength":1,"maxLength":18},"computerized_reservation_system":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/Computer_reservation_system","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to make the reservation and purchase the ticket."},"children":[]}]}]}],"minLength":4,"maxLength":4},"customer_reference_number":{"type":"string","maxLength":20,"description":"Alphanumeric customer reference number."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code identifying the type of item bought."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ticket"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" baggage receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exchange ticket"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"04"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Miscellaneous Charges Order (MCO)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Electronic Miscellaneous Document (EMD)"},"children":[]}]}]}]}],"enum":["01","02","03","04","05"]},"flight_date":{"type":"string","description":"Datetime of flight departure.","minLength":10,"maxLength":16},"agency_plan_name":{"type":"string","description":"Two-letter agency plan identifier.","minLength":2,"maxLength":2},"travel_agency_name":{"type":"string","description":"Name of the travel agency.","minLength":1,"maxLength":25},"travel_agency_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier from "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.iata.org/en/services/codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IATA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for travel agency that issues the ticket."},"children":[]}]}]}],"minLength":1,"maxLength":8},"agency_invoice_number":{"type":"string","description":"Reference number for the invoice issued by the agency.","minLength":1,"maxLength":6},"ticket":{"required":["number","issue_date","issue_address"],"description":"Ticket-related details.","additionalProperties":false,"properties":{"number":{"type":"string","description":"Unique identifier for the ticket.","minLength":1,"maxLength":15},"issue_date":{"type":"string","description":"Date the ticket was issued to the passenger.","minLength":6,"maxLength":6,"format":"YYMMDD"},"restricted":{"type":"boolean","description":"Indicates if the ticket is restricted.","default":false},"issue_address":{"type":"object","description":"Address where the ticket was issued.","required":["line1","city","country","postal"],"additionalProperties":false,"properties":{"line1":{"type":"string","description":"First line of the issue address.","minLength":0,"maxLength":16},"city":{"type":"string","description":"City where the ticket was issued.","maxLength":100},"country":{"type":"string","description":"Country where the ticket was issued.","format":"iso_code_a3","minLength":3,"maxLength":3},"postal":{"type":"string","description":"Postal code where the ticket was issued.","maxLength":10}}}}},"passenger":{"type":"object","description":"Passenger-related details.","required":["first_name","last_name"],"additionalProperties":false,"properties":{"first_name":{"type":"string","description":"First name of the passenger.","maxLength":100},"last_name":{"type":"string","description":"Last name of the passenger.","maxLength":100},"date_of_birth":{"type":"string","description":"Date of birth of the passenger.","format":"yyyy-MM-dd","minLength":10,"maxLength":10},"phone_number":{"type":"string","description":"Phone number of the passenger, including country code.","minLength":3,"maxLength":30},"traveller_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.iata.org/en/services/codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IATA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" passenger type code (PTC)."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ADT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" adult"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHD"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" child"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" infant"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SRC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YTH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" student/youth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MIL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" military, etc."},"children":[]}]}]}]}],"enum":["ADT","CHD","INF","SRC","YTH","MIL"]},"code":{"type":"string","description":"Passenger-specific code for identifying the traveler.","maxLength":255}}},"flight_legs":{"type":"array","description":"Flight legs details.","minItems":1,"maxItems":4,"items":{"type":"object","required":["flight_number","carrier_code","class_of_travel","departure_date","departure_airport","arrival_airport"],"additionalProperties":false,"properties":{"flight_number":{"type":"string","description":"Flight identifier.","minLength":1,"maxLength":5},"carrier_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.iata.org/en/services/codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IATA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 2-letter airline designator that identifies the carrier."},"children":[]}]}]}],"minLength":2,"maxLength":2},"class_of_travel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A one-letter identifier for the travel class."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" first class"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"J"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" business class"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" economy class"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" premium economy, etc."},"children":[]}]}]}]}],"enum":["F","J","Y","W"]},"departure_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of travel in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minLength":16,"maxLength":16},"departure_airport":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.iata.org/en/services/codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IATA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 3-letter airport code of the departure airport."},"children":[]}]}]}],"minLength":3,"maxLength":3},"departure_tax":{"type":"string","description":"Amount of departure tax charged, in minor units.","minLength":1,"maxLength":12},"arrival_airport":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.iata.org/en/services/codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IATA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 3-letter airport code of the destination airport."},"children":[]}]}]}],"minLength":3,"maxLength":3},"fare_base_code":{"type":"string","description":"Fare basis code.","minLength":1,"maxLength":15},"stop_over_code":{"type":"string","description":"A one-letter code indicating stopover eligibility.","enum":["O","X"],"default":"X"}}}}}}}}}},"components/schemas/SchemaCardsIndustryDataDiscriminatorAirline":{"id":"components/schemas/SchemaCardsIndustryDataDiscriminatorAirline","kind":"json-schema","title":"SchemaCardsIndustryDataDiscriminatorAirline","data":{"title":"SchemaCardsIndustryDataDiscriminatorAirline","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/industry-data/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industry-related"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data for airline payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Applicable to merchants operating under airline-related MCCs 3000–3350 or travel agencies MCC 4722."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supplying this enriched data can help reduce fees, improve fraud detection and dispute handling, increase customer trust, and support industry compliance."},"children":[]}]}]}],"properties":{"type":{"type":"string"}},"discriminator":{"propertyName":"type","mapping":{"airline":"#/components/schemas/SchemaCardsIndustryDataAirline"}}}},"components/schemas/SchemaCardsShippingAddressAppleGoogle":{"id":"components/schemas/SchemaCardsShippingAddressAppleGoogle","kind":"json-schema","title":"CardShippingAddressModel","data":{"title":"CardShippingAddressModel","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address to ship."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If this field is passed by the merchant - the customer cannot change this address."},"children":[]}]}]}],"properties":{"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the shipping address."},"children":[]}]}]}],"format":"iso_code_a3","example":"USA","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the shipping address."},"children":[]}]}]}],"maxLength":10,"example":"NY"},"city":{"type":"string","description":"Shipping address city.","maxLength":100,"example":"Boston"},"zip":{"type":"string","description":"Address zip/postal code where the person, business or institution is located.","maxLength":10,"example":"91191"},"address":{"type":"string","description":"First and second line of the shipping address.","maxLength":100,"example":"123 Main St"}}}},"components/schemas/SchemaCardsDeviceSession":{"id":"components/schemas/SchemaCardsDeviceSession","kind":"json-schema","title":"SchemaCardsDeviceSession","data":{"title":"SchemaCardsDeviceSession","type":"object","properties":{"id":{"type":"string","description":"Unique device session identifier.","maxLength":255,"example":"dsid_3a20_f9c1_4cd8_89d3_1c5"},"provider":{"type":"string","description":"Third-party provider for the device session.","enum":["checkout","airwallex"],"example":"checkout"}}}},"components/schemas/SchemaCardsDeviceSessions":{"id":"components/schemas/SchemaCardsDeviceSessions","kind":"json-schema","title":"SchemaCardsDeviceSessions","data":{"title":"SchemaCardsDeviceSessions","type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/device-sessions/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device sessions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with session ID and provider."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SchemaCardsDeviceSession"}}},"components/schemas/RequestCardsCharge":{"id":"components/schemas/RequestCardsCharge","kind":"json-schema","title":"PAN Payment","data":{"title":"PAN Payment","type":"object","required":["order_id","amount","currency","order_description","payment_type","customer_email","ip_address","platform","card_number","card_exp_month","card_exp_year","type"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is valid only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow. If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the default fallback value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will be used. "},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"card_data_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card data "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/#network-tokens","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":"pan","enum":["pan"]},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not provided."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Payment will be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"neither "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified alongside the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]}]}]}]}],"enum":["1-click","recurring","retry","installment","rebill","moto"]},"scheme_transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (max length 16)"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 1-3: Financial Network Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 4-9: Banknet Reference Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 10-12: Space filled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 13-16: Banknet Settlement Date"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Numeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amex"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (16)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify this parameter with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"installment"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rebill"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", as the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"scheme_transaction_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" ensures continuity between MITs and the original CIT."},"children":[]}]}]}]},"transaction_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Link Identifier ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is an ID generated by Mastercard to link lifecycle activity after the original transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with customer-initiated (CIT) "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and send it with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"external_mpi_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object, as it helps optimize payment success rates."},"children":[]}]}]}],"default":false},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersion"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary account number (PAN) of the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in its "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unmasked format"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", containing the full primary account number (PAN) without any masked digits."},"children":[]}]}]}],"minLength":12,"maxLength":19,"pattern":"^[0-9]{12,19}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$","example":"John Snow"},"card_exp_month":{"type":"string","description":"Expiry month of the card.","minLength":2,"maxLength":2},"card_exp_year":{"type":"integer","description":"Expiry year of the card."},"card_cvv":{"type":"string","description":"Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.","pattern":"^[0-9]{3,4}$"},"card_pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal identification number (PIN) associated with the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only for VERVE card brand."},"children":[]}]}]}],"maxLength":10},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"industry_data":{"$ref":"#/components/schemas/SchemaCardsIndustryDataDiscriminatorAirline"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"city":{"type":"string","description":"Billing address city.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"maxLength":3,"minLength":3,"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/SchemaCardsPaymentChargeDataTypeDpanApple":{"id":"components/schemas/SchemaCardsPaymentChargeDataTypeDpanApple","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","required":["order_id","amount","currency","order_description","payment_type","dpan_source","scheme_transaction_id","customer_email","ip_address","platform","card_number","card_exp_month","card_exp_year","type"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is valid only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow. If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the default fallback value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will be used. "},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"card_data_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card data "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/#network-tokens","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_data_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not provided, the default "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"pan"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" assumed for one-time payment with PAN."},"children":[]}]}]}],"default":"pan","enum":["dpan"]},"dpan_source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source for network tokens generated through Apple Pay."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_data_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"dpan"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is provided."},"children":[]}]}]}],"default":"apple-pay"},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not provided."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Payment will be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"neither "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified alongside the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]}]}]}]}],"enum":["recurring","retry","installment","rebill","moto"]},"scheme_transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (max length 16)"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 1-3: Financial Network Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 4-9: Banknet Reference Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 10-12: Space filled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 13-16: Banknet Settlement Date"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Numeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amex"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (16)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify this parameter with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"installment"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rebill"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", as the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"scheme_transaction_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" ensures continuity between MITs and the original CIT."},"children":[]}]}]}]},"transaction_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Link Identifier ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is an ID generated by Mastercard to link lifecycle activity after the original transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with customer-initiated (CIT) "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"default":false},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersion"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary account number (PAN) of the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in its "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unmasked format"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", containing the full primary account number (PAN) without any masked digits."},"children":[]}]}]}],"minLength":12,"maxLength":19,"pattern":"^[0-9]{12,19}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$","example":"John Snow"},"card_exp_month":{"type":"string","description":"Expiry month of the card.","minLength":2,"maxLength":2},"card_exp_year":{"type":"integer","description":"Expiry year of the card."},"card_cvv":{"type":"string","description":"Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.","pattern":"^[0-9]{3,4}$"},"card_pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal identification number (PIN) associated with the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only for VERVE card brand."},"children":[]}]}]}],"maxLength":10},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"industry_data":{"$ref":"#/components/schemas/SchemaCardsIndustryDataDiscriminatorAirline"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"maxLength":3,"minLength":3,"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/SchemaCardsPaymentChargeDataTypeDpanGoogle":{"id":"components/schemas/SchemaCardsPaymentChargeDataTypeDpanGoogle","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","required":["order_id","amount","currency","order_description","payment_type","dpan_source","scheme_transaction_id","customer_email","ip_address","platform","card_number","card_exp_month","card_exp_year","type"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is valid only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow. If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the default fallback value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will be used. "},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"card_data_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card data "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/#network-tokens","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_data_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not provided, the default "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"pan"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" assumed for one-time payment with PAN."},"children":[]}]}]}],"default":"pan","enum":["dpan"]},"dpan_source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source for network tokens generated through Google Pay."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_data_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"dpan"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is provided."},"children":[]}]}]}],"default":"google-pay"},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not provided."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Payment will be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"neither "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified alongside the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]}]}]}]}],"enum":["recurring","retry","installment","rebill","moto"]},"scheme_transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (max length 16)"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 1-3: Financial Network Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 4-9: Banknet Reference Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 10-12: Space filled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 13-16: Banknet Settlement Date"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Numeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amex"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (16)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify this parameter with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"installment"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rebill"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", as the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"scheme_transaction_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" ensures continuity between MITs and the original CIT."},"children":[]}]}]}]},"transaction_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Link Identifier ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is an ID generated by Mastercard to link lifecycle activity after the original transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with customer-initiated (CIT) "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"default":false},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersion"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary account number (PAN) of the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in its "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unmasked format"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", containing the full primary account number (PAN) without any masked digits."},"children":[]}]}]}],"minLength":12,"maxLength":19,"pattern":"^[0-9]{12,19}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$","example":"John Snow"},"card_exp_month":{"type":"string","description":"Expiry month of the card.","minLength":2,"maxLength":2},"card_exp_year":{"type":"integer","description":"Expiry year of the card."},"card_cvv":{"type":"string","description":"Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.","pattern":"^[0-9]{3,4}$"},"card_pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal identification number (PIN) associated with the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only for VERVE card brand."},"children":[]}]}]}],"maxLength":10},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"industry_data":{"$ref":"#/components/schemas/SchemaCardsIndustryDataDiscriminatorAirline"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"maxLength":3,"minLength":3,"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/SchemaCardsExternalMpiDsVersionDpanCitMit":{"id":"components/schemas/SchemaCardsExternalMpiDsVersionDpanCitMit","kind":"json-schema","title":"SchemaCardsExternalMpiDsVersionDpanCitMit","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required information to process a payment that has been 3DS authenticated using a third-party merchant plug-in (MPI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide this data, as it reduces the risk of transaction failures."},"children":[]}]}]}],"required":["three_ds_version","eci","cryptogram","ds_transaction_id","authentication_response","three_ds_flow"],"properties":{"three_ds_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the version of 3D Secure used for authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"2.X.X"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" pattern."},"children":[]}]}]}],"enum":["2.1.0","2.2.0"]},"three_ds_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the authentication "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/3ds-verification/#mpi-data-insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["frictionless","challenge","none"]},"acs_challenge_mandated_ind":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the issuer preference for whether or not a 3DS challenge should be performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The issuer has the final say on whether or not the customer receives the challenge."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible values as they are defined in 3D Secure 2 protocols."},"children":[]}]}]}],"minLength":1,"maxLength":1},"transaction_challenge_exemption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Control Server (ACS) applies an exemption to authenticate the transaction without requesting a challenge."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible values as they are defined in 3D Secure 2 protocols."},"children":[]}]}]}],"minLength":2,"maxLength":2},"challenge_cancel_ind":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible values as defined in 3D Secure 2 protocols."},"children":[]}]}]}],"minLength":2,"maxLength":2},"eci":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic Commerce Indicator ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") level associated with the 3D Secure enrollment result."},"children":[]}]}]}],"minLength":1,"maxLength":2},"cryptogram":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64 encoded cardholder authentication value (20 bytes in decoded form) used for validating the authentication result."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In 3D Secure 2 this is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticationValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in the ARes (if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frictionless flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or the RReq (if a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"challenge flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" together with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":64},"cryptogram_algorithm":{"type":"string","description":"Algorithm used by Issuer Access Control Server (ACS) to calculate the cryptogram.","minLength":1,"maxLength":1},"authentication_response":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/3ds-verification/#mpi-data-insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned from the card Issuer’s Access Control Server (ACS) or Scheme Directory Server (DS)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" received in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the ARes (Authentication Response) message in case of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frictionless flow"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the last CRes (Challenge Response) message in case of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"challenge flow"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or in the RReq (Results Request) message sent after the cardholder completes the challenge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the transaction was frictionless, there are no CRes or RReq messages."},"children":[]}]}]}],"enum":["Y","A"]},"ds_transaction_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the reason for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in 3D Secure 2."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible values as defined in 3D Secure 2 protocols."},"children":[]}]}]}],"minLength":2,"maxLength":2},"ds_transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction identifier assigned by the Directory Server (DS) to identify a single transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"eci"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" values "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"01"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"02"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"05"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"06"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" when 3DS2 is used."},"children":[]}]}]}],"minLength":1,"maxLength":100},"three_ds_server_transaction_id":{"type":"string","description":"Identifier assigned by the 3D Secure 2 server to a single transaction.","minLength":1,"maxLength":100},"acs_transaction_id":{"type":"string","description":"Transaction identifier assigned by the ACS to identify a single transaction.","minLength":36,"maxLength":36,"format":"uuid"},"authentication_method":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the authentication "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/3ds-verification/#mpi-data-insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the issuer will use to challenge the cardholder in the ARes message, or those used by the ACS in the RReq message."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"12"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (decoupled) is not supported."},"children":[]}]}]}],"items":{"type":"string","minLength":2,"maxLength":2}},"authentication_timestamp":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication datetime in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minLength":6,"maxLength":25}}}},"components/schemas/SchemaCardsPaymentChargeDataTypeDpanVts":{"id":"components/schemas/SchemaCardsPaymentChargeDataTypeDpanVts","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","required":["order_id","amount","currency","order_description","payment_type","dpan_source","customer_email","ip_address","platform","card_number","card_exp_month","card_exp_year","type"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is valid only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow. If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the default fallback value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will be used. "},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"card_data_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card data "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/#network-tokens","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_data_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not provided, the default "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"pan"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" assumed for one-time payment with PAN."},"children":[]}]}]}],"default":"pan","enum":["dpan"]},"dpan_source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source for network tokens generated through Visa Token Service (VTS)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_data_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"dpan"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is provided."},"children":[]}]}]}],"default":"vts"},"eci":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic Commerce Indicator ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") level associated with the network token authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":2},"cryptogram":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64 encoded cardholder authentication value provided with the network token and used for validating the authentication result."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":64},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not provided."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Payment will be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"neither "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified alongside the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]}]}]}]}],"enum":["1-click","recurring","retry","installment","rebill","moto"]},"scheme_transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (max length 16)"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 1-3: Financial Network Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 4-9: Banknet Reference Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 10-12: Space filled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 13-16: Banknet Settlement Date"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Numeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amex"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (16)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify this parameter with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"installment"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rebill"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", as the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"scheme_transaction_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" ensures continuity between MITs and the original CIT."},"children":[]}]}]}]},"transaction_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Link Identifier ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is an ID generated by Mastercard to link lifecycle activity after the original transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with customer-initiated (CIT) "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"installment"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rebill"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and send it with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"external_mpi_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object."},"children":[]}]}]}],"default":false},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersionDpanCitMit"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary account number (PAN) of the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in its "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unmasked format"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", containing the full primary account number (PAN) without any masked digits."},"children":[]}]}]}],"minLength":12,"maxLength":19,"pattern":"^[0-9]{12,19}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$","example":"John Snow"},"card_exp_month":{"type":"string","description":"Expiry month of the card.","minLength":2,"maxLength":2},"card_exp_year":{"type":"integer","description":"Expiry year of the card."},"card_cvv":{"type":"string","description":"Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.","pattern":"^[0-9]{3,4}$"},"card_pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal identification number (PIN) associated with the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only for VERVE card brand."},"children":[]}]}]}],"maxLength":10},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"industry_data":{"$ref":"#/components/schemas/SchemaCardsIndustryDataDiscriminatorAirline"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"maxLength":3,"minLength":3,"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/SchemaCardsPaymentChargeDataTypeDpanMdes":{"id":"components/schemas/SchemaCardsPaymentChargeDataTypeDpanMdes","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","required":["order_id","amount","currency","order_description","payment_type","dpan_source","customer_email","ip_address","platform","card_number","card_exp_month","card_exp_year","type"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is valid only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow. If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the default fallback value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will be used. "},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"card_data_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card data "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/#network-tokens","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_data_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not provided, the default "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"pan"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" assumed for one-time payment with PAN."},"children":[]}]}]}],"default":"pan","enum":["dpan"]},"dpan_source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source for network tokens generated through Mastercard Digital Enablement Service (MDES)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_data_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"dpan"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is provided."},"children":[]}]}]}],"default":"mdes"},"eci":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic Commerce Indicator ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") level associated with the network token authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":2},"cryptogram":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64 encoded cardholder authentication value provided with the network token and used for validating the authentication result."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":64},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not provided."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Payment will be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"neither "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified alongside the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]}]}]}]}],"enum":["1-click","recurring","retry","installment","rebill","moto"]},"scheme_transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (max length 16)"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 1-3: Financial Network Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 4-9: Banknet Reference Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 10-12: Space filled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 13-16: Banknet Settlement Date"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Numeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amex"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (16)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify this parameter with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"installment"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rebill"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", as the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"scheme_transaction_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" ensures continuity between MITs and the original CIT."},"children":[]}]}]}]},"transaction_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Link Identifier ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is an ID generated by Mastercard to link lifecycle activity after the original transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with customer-initiated (CIT) "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"installment"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rebill"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and send it with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"external_mpi_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object."},"children":[]}]}]}],"default":false},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersionDpanCitMit"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary account number (PAN) of the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in its "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unmasked format"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", containing the full primary account number (PAN) without any masked digits."},"children":[]}]}]}],"minLength":12,"maxLength":19,"pattern":"^[0-9]{12,19}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$","example":"John Snow"},"card_exp_month":{"type":"string","description":"Expiry month of the card.","minLength":2,"maxLength":2},"card_exp_year":{"type":"integer","description":"Expiry year of the card."},"card_cvv":{"type":"string","description":"Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.","pattern":"^[0-9]{3,4}$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"industry_data":{"$ref":"#/components/schemas/SchemaCardsIndustryDataDiscriminatorAirline"},"card_pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal identification number (PIN) associated with the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only for VERVE card brand."},"children":[]}]}]}],"maxLength":10},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"maxLength":3,"minLength":3,"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/SchemaCardsPaymentChargeDataTypeDpanScof":{"id":"components/schemas/SchemaCardsPaymentChargeDataTypeDpanScof","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","required":["order_id","amount","currency","order_description","payment_type","dpan_source","customer_email","ip_address","platform","card_number","card_exp_month","card_exp_year","type"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is valid only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow. If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the default fallback value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will be used. "},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"card_data_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card data "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/#network-tokens","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_data_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not provided, the default "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"pan"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" assumed for one-time payment with PAN."},"children":[]}]}]}],"default":"pan","enum":["dpan"]},"dpan_source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source for network tokens generated through Secure Card on File (SCOF)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_data_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"dpan"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is provided."},"children":[]}]}]}],"default":"scof"},"eci":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic Commerce Indicator ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") level associated with the network token authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":2},"cryptogram":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64 encoded cardholder authentication value provided with the network token and used for validating the authentication result."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":64},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not provided."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Payment will be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"neither "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified alongside the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]}]}]}]}],"enum":["1-click","recurring","retry","installment","rebill","moto"]},"scheme_transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (max length 16)"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 1-3: Financial Network Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 4-9: Banknet Reference Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 10-12: Space filled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 13-16: Banknet Settlement Date"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Numeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amex"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (16)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify this parameter with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"installment"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rebill"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", as the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"scheme_transaction_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" ensures continuity between MITs and the original CIT."},"children":[]}]}]}]},"transaction_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Link Identifier ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is an ID generated by Mastercard to link lifecycle activity after the original transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with customer-initiated (CIT) "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"installment"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rebill"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and send it with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"external_mpi_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object."},"children":[]}]}]}],"default":false},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersionDpanCitMit"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary account number (PAN) of the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in its "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unmasked format"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", containing the full primary account number (PAN) without any masked digits."},"children":[]}]}]}],"minLength":12,"maxLength":19,"pattern":"^[0-9]{12,19}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$","example":"John Snow"},"card_exp_month":{"type":"string","description":"Expiry month of the card.","minLength":2,"maxLength":2},"card_exp_year":{"type":"integer","description":"Expiry year of the card."},"card_cvv":{"type":"string","description":"Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.","pattern":"^[0-9]{3,4}$"},"card_pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal identification number (PIN) associated with the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only for VERVE card brand."},"children":[]}]}]}],"maxLength":10},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"industry_data":{"$ref":"#/components/schemas/SchemaCardsIndustryDataDiscriminatorAirline"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"maxLength":3,"minLength":3,"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/RequestCardsPaymentChargeDataType":{"id":"components/schemas/RequestCardsPaymentChargeDataType","kind":"json-schema","title":"DPAN Payment","data":{"title":"DPAN Payment","type":"object","properties":{"dpan_source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Apple Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false}},"discriminator":{"propertyName":"dpan_source","mapping":{"apple-pay":"#/components/schemas/SchemaCardsPaymentChargeDataTypeDpanApple","google-pay":"#/components/schemas/SchemaCardsPaymentChargeDataTypeDpanGoogle","vts":"#/components/schemas/SchemaCardsPaymentChargeDataTypeDpanVts","mdes":"#/components/schemas/SchemaCardsPaymentChargeDataTypeDpanMdes","scof":"#/components/schemas/SchemaCardsPaymentChargeDataTypeDpanScof"}}}},"components/schemas/RequestCardsProductBasedPaymentCharge":{"id":"components/schemas/RequestCardsProductBasedPaymentCharge","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","type":"object","required":["order_id","product_id","order_description","payment_type","customer_email","ip_address","platform","card_number","card_exp_month","card_exp_year","customer_account_id","type"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not provided."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Payment will be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"neither "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified alongside the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]}]}]}]}],"enum":["1-click","recurring","retry","installment","rebill","moto"]},"scheme_transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (max length 16)"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 1-3: Financial Network Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 4-9: Banknet Reference Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 10-12: Space filled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 13-16: Banknet Settlement Date"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Numeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amex"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (16)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type:moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify this parameter with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"installment"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rebill"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", as the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"scheme_transaction_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" ensures continuity between MITs and the original CIT."},"children":[]}]}]}]},"transaction_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Link Identifier ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is an ID generated by Mastercard to link lifecycle activity after the original transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with customer-initiated (CIT) "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and send it with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"external_mpi_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object, as it helps optimize payment success rates."},"children":[]}]}]}]},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersion"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary account number (PAN) of the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in its "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unmasked format"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", containing the full primary account number (PAN) without any masked digits."},"children":[]}]}]}],"minLength":12,"maxLength":19,"pattern":"^[0-9]{12,19}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$","example":"John Snow"},"card_exp_month":{"type":"string","description":"Expiry month of the card.","minLength":2,"maxLength":2},"card_exp_year":{"type":"integer","description":"Expiry year of the card."},"card_cvv":{"type":"string","description":"Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.","pattern":"^[0-9]{3,4}$"},"card_pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal identification number (PIN) associated with the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only for VERVE card brand."},"children":[]}]}]}],"maxLength":10},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"city":{"type":"string","description":"Billing address city.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/RequestCardsSubscriptionPaymentCharge":{"id":"components/schemas/RequestCardsSubscriptionPaymentCharge","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","type":"object","required":["order_id","product_id","order_description","payment_type","customer_email","ip_address","platform","card_number","card_exp_month","card_exp_year","customer_account_id","type"],"properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not provided."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Payment will be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"neither "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is specified alongside the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]}]}]}]}],"enum":["1-click","recurring","retry","installment","rebill","moto"]},"scheme_transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (max length 16)"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 1-3: Financial Network Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 4-9: Banknet Reference Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 10-12: Space filled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positions 13-16: Banknet Settlement Date"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Numeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amex"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (15)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Alphanumeric (16)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type:moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify this parameter with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"installment"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rebill"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", as the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"scheme_transaction_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" ensures continuity between MITs and the original CIT."},"children":[]}]}]}]},"transaction_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Link Identifier ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is an ID generated by Mastercard to link lifecycle activity after the original transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided with customer-initiated (CIT) "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"moto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_cvv"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of retry attempts for the subscription payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use it for analytics and conversion tuning purposes."},"children":[]}]}]}],"minimum":0},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and send it with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"external_mpi_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object, as it helps optimize payment success rates."},"children":[]}]}]}]},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersion"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary account number (PAN) of the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in its "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unmasked format"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", containing the full primary account number (PAN) without any masked digits."},"children":[]}]}]}],"minLength":12,"maxLength":19,"pattern":"^[0-9]{12,19}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$","example":"John Snow"},"card_exp_month":{"type":"string","description":"Expiry month of the card.","minLength":2,"maxLength":2},"card_exp_year":{"type":"integer","description":"Expiry year of the card."},"card_cvv":{"type":"string","description":"Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.","pattern":"^[0-9]{3,4}$"},"card_pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal identification number (PIN) associated with the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only for VERVE card brand."},"children":[]}]}]}],"maxLength":10},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"city":{"type":"string","description":"Billing address city.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/SchemaCardsOrder":{"id":"components/schemas/SchemaCardsOrder","kind":"json-schema","title":"CardsOrderModel","data":{"title":"CardsOrderModel","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","type":"object","required":["amount","currency","order_id","refunded_amount","status"],"properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255,"example":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55"},"order_description":{"type":"string","description":"Brief order description.","maxLength":255,"example":"Premium package"},"psp_order_id":{"type":"string","description":"PSP identifier generated by Solidgate."},"provider_payment_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PSP identifier generated by the PSP."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Value will be if the integration transmitted this data."},"children":[]}]}]}]},"subscription_id":{"type":"string","description":"Unique subscription identifier.","format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-4df0-899a-dda84fd2705e"},"invoice_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique invoice identifier associated with the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Retrieve invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/v2/invoices","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invoices"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" API V2."},"children":[]}]}]}],"maxLength":100,"example":"inv_01KPWT0K1PQWEYYRT7J1H3NC85"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This is the intended initial authorization amount."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]}]}],"example":100},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"processing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of the payment in the smallest currency unit as it was processed by the payment service provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This amount may differ from the original order amount due to currency conversion or other processing factors."},"children":[]}]}]}]},"processing_currency":{"type":"string","minLength":3,"maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the payment when it was processed by payment service provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In some cases, it is different from the original currency."},"children":[]}]}]}],"example":"USD"},"marketing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This is based on the intended initial authorization amount."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It should not be considered financial information, but it can be used for forecasting."},"children":[]}]}]}]},"marketing_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the currency used for calculation of marketing amount."},"children":[]}]}]}],"example":"USD"},"refunded_amount":{"description":"Indicates the amount that has been already refunded.","type":"integer"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["processing","3ds_verify","refunded","auth_ok","auth_failed","settle_ok","partial_settled","void_ok"],"example":"processing"},"auth_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction authorization code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It can be empty if the provider does not pass a value."},"children":[]}]}]}],"example":"2w9m8"},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]}],"enum":["1-click","recurring","retry","installment","rebill","moto"]},"payment_method":{"type":"string","description":"Payment method used for the transaction."},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100,"example":"example@example.com"},"descriptor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying text that appears on a customer’s credit or debit card statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It includes information about the transaction and helps the cardholder recognize the charge."},"children":[]}]}]}],"example":"google.com"},"mid":{"type":"string","description":"Merchant identifier in Solidgate.","example":"bank-mid-1"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255,"example":"facebook"},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/SchemaCardsBillingDetails":{"id":"components/schemas/SchemaCardsBillingDetails","kind":"json-schema","title":"SchemaCardsBillingDetails","data":{"title":"SchemaCardsBillingDetails","type":"object","description":"Billing address details.","properties":{"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city."},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}]},"zip":{"type":"string","description":"Billing zip/postal code."}}}},"components/schemas/SchemaCardsCardToken":{"id":"components/schemas/SchemaCardsCardToken","kind":"json-schema","title":"CardsCardTokenModel","data":{"title":"CardsCardTokenModel","type":"object","description":"Token associated with a card method that can be used for subsequent payments.","properties":{"token":{"type":"string","description":"Token generated for a card method, enabling its use for future payments.","example":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}}}},"components/schemas/SchemaCardsCard":{"id":"components/schemas/SchemaCardsCard","kind":"json-schema","title":"CardModel","data":{"title":"CardModel","type":"object","description":"Object containing detailed information about the card used in the transaction.","required":["bin","card_exp_month","card_exp_year","number"],"properties":{"bank":{"type":"string","description":"Name of the card issuer.","example":"JSC UNIVERSAL BANK"},"bin":{"type":"string","minLength":6,"maxLength":6,"description":"Card issuer Bank Identification Number (BIN).","example":"444111"},"brand":{"type":"string","description":"Card brand.","example":"VISA"},"card_exp_month":{"type":"string","description":"Expiry month of the card.","minLength":2,"maxLength":2,"example":"12"},"card_exp_year":{"type":"integer","description":"Expiry year of the card.","example":2030},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$","example":"John Snow"},"card_type":{"type":"string","description":"Card type.","enum":["CREDIT","CREDIT/DEBIT","DEBIT","PREPAID","CHARGE CARD","DEFERRED DEBIT"],"example":"CREDIT"},"card_category":{"type":"string","description":"Card category.","enum":["ANONYMOUS PREPAID","COMMERCIAL DEBIT","CONSUMER DEBIT","PREPAID","PREPAID RELOADABLE","SMALL BUSINESS","BUSINESS","COMMERCIAL","GOVERNMENT NOTES","PAYOUTS","CONSUMER","CORPORATE"],"example":"CONSUMER"},"is_reloadable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#reloadable-prepaid-indicator","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of whether the card belongs to a reloadable program."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" means the reloadable indicator is not available."},"children":[]}]}]}],"example":true},"card_id":{"type":"string","description":"Unique identifier of the card used for the transaction.","format":"uuid","example":"22733af4-f6c6-4368-b7d0-98aeb0253a57"},"country":{"type":"string","description":"Card issuer country.","format":"iso_code_a3","example":"USA","maxLength":3,"minLength":3},"number":{"type":"string","description":"Masked card number.","maxLength":19,"example":"444111XXXXXX9435"},"card_token":{"$ref":"#/components/schemas/SchemaCardsCardToken"}}}},"components/schemas/SchemaCardsError":{"id":"components/schemas/SchemaCardsError","kind":"json-schema","title":"CardsError","data":{"title":"CardsError","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"required":["code","messages"],"properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the declined payment."},"children":[]}]}]}],"enum":["X.XX"]},"messages":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array containing either strings or objects that provide details about the error or status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"When it is an array of strings, each string describes a separate issue. When it is an object, the object will contain key-value pairs explaining the issue in more detail."},"children":[]}]}]}],"items":{"oneOf":[{"type":"string"},{"type":"object"}]}},"recommended_message_for_user":{"type":"string","description":"Message with recommended next steps or additional information.","example":"The problem here lies with the data format and accuracy, validation error on the acquiring side"},"merchant_advice_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant Advice Codes (MACs) are introduced by Mastercard to clearly communicate to merchants the reason for declining transactions, and the course of action that merchants can take."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If present, the MAC contains information about why the payment failed, whether it can be retried and in some cases, the recommended duration after which it should be retried."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Follow to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/recover-revenue/merchant-advice-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"merchant advice codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to get recommendations to handle the value."},"children":[]}]}]}]}}}},"components/schemas/SchemaCardsTransaction":{"id":"components/schemas/SchemaCardsTransaction","kind":"json-schema","title":"CardTransactionModel","data":{"title":"CardTransactionModel","type":"object","description":"Details of a card transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.","required":["amount","card","created_at","currency","id","operation","status","updated_at"],"properties":{"id":{"type":"string","description":"Unique transaction identifier.","example":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2026-07-15 11:45:30"},"updated_at":{"type":"string","description":"Datetime when the transaction was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2026-07-16 11:45:30"},"amount":{"type":"integer","description":"Transaction amount.","example":100},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the transaction."},"children":[]}]}]}],"maxLength":3,"minLength":3,"example":"USD"},"marketing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It should not be considered financial information, but it can be used for forecasting."},"children":[]}]}]}]},"marketing_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the currency used for calculation of marketing amount."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["recurring-auth","refund","resign-auth","auth","settle","void","apple-pay","google-pay"],"example":"auth"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["processing","success","fail","verify"],"example":"success"},"authorization_type":{"type":"string","enum":["final","estimated","incremental"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"scheme_transaction_id":{"type":"string","description":"Card-scheme transaction identifier linking this transaction to the original customer-initiated payment."},"transaction_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Link Identifier ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is an ID generated by Mastercard to link lifecycle activity after the original transaction."},"children":[]}]}]}],"maxLength":255},"descriptor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying text that appears on a customer’s credit or debit card statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It includes information about the transaction and helps the cardholder recognize the charge."},"children":[]}]}]}],"example":"google.com"},"billing_details":{"$ref":"#/components/schemas/SchemaCardsBillingDetails"},"refund_reason":{"type":"string","description":"Text description of the refund reason.","example":"Solidgate - Issuer Fraud Notification"},"refund_reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code representing the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/refund-reasons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reason"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This code is used to identify the reason for both "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" transactions "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"operation"},"children":[]}]}]}]}],"minLength":4,"maxLength":4,"example":"0022"},"card_token":{"$ref":"#/components/schemas/SchemaCardsCardToken"},"card":{"$ref":"#/components/schemas/SchemaCardsCard"},"error":{"$ref":"#/components/schemas/SchemaCardsError"},"payment_account_reference":{"type":"string","description":"Payment Account Reference (PAR) is a unique, non-financial identifier for a payment account that remains consistent across card replacements.","example":"PAR_1A2B3C4D5E6F7G8H9"},"arn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acquirer Reference Number (ARN) assigned to transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use ARN to check transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"rrn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieval Reference Number (RRN) assigned to transactions, based on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8583","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8583"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standard."},"children":[]}]}]}],"minLength":12,"maxLength":12}}}},"components/schemas/SchemaCardsThreeDs":{"id":"components/schemas/SchemaCardsThreeDs","kind":"json-schema","title":"CardThreeDSExtendedModel","data":{"title":"CardThreeDSExtendedModel","type":"object","description":"Information related to the processing of the payment.","properties":{"eci":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic Commerce Indicator ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") security level used to authorize the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Applicable for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"digital wallet"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/card-schemes-tokenization/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"network token"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" payments."},"children":[]}]}]}],"example":"05"},"flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/3ds-verification/#3d-secure","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" whether and how the customer was involved in the 3D Secure."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Flow "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" indicates that 3D Secure authentication was not initiated for the transaction."},"children":[]}]}]}],"enum":["frictionless","challenge","none","unspecified"],"example":"none"},"exception":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Strong Customer Authentication ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/3ds-verification/#3d-secure","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") exception type applied to the transaction."},"children":[]}]}]}],"enum":["low_value","transaction_risk_assessment"],"example":"low_value"}}}},"components/schemas/SchemaCardsRouting":{"id":"components/schemas/SchemaCardsRouting","kind":"json-schema","title":"SchemaCardsRouting","data":{"title":"SchemaCardsRouting","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment routing information."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The availability of this object depends on whether routing is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/orchestration/routing/#configure-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"configured"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for your account."},"children":[]}]}]}],"properties":{"cascade_steps":{"type":"array","description":"Details of the attempts made to process the payment.","items":{"type":"object","properties":{"mid":{"type":"string","description":"Merchant identifier in Solidgate."},"mid_descriptor":{"type":"string","description":"Identifying text that appears on a customer's credit or debit card statement."},"route_id":{"type":"string","description":"Route identifier configured in Solidgate."},"cascade_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sequential number of the processing attempt in the routing cascade, fallback step number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Indicates which attempt in the fallback sequence was used to process the payment."},"children":[]}]}]}]},"segment_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the segment used for this processing attempt in the routing configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Each segment represents a specific processing configuration within a route."},"children":[]}]}]}]},"legal_entity_id":{"type":"string","description":"Unique identifier of the legal entity associated with the connector account.","example":"12560"},"legal_entity_name":{"type":"string","description":"Name of the legal entity associated with the connector account.","example":"SOLIDGATE TECH LIMITED"}}}}}}},"components/schemas/SchemaCardsAntifraudResult":{"id":"components/schemas/SchemaCardsAntifraudResult","kind":"json-schema","title":"SchemaCardsAntifraudResult","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-authorization decision returned by Solidgate Antifraud."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Returned only when the merchant uses Solidgate’s internal antifraud service, which excludes provider-side fraud results."},"children":[]}]}]}],"properties":{"pre_auth":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outcome of the real-time antifraud screening performed before the authorization request is sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - transaction declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"review"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - requires manual review"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pass"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - approved to proceed"},"children":[]}]}]}]}],"enum":["reject","review","pass"],"example":"pass"}}}},"components/schemas/SchemaCardsAniResult":{"id":"components/schemas/SchemaCardsAniResult","kind":"json-schema","title":"SchemaCardsAniResult","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANI "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/verification-result/#ani","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"result"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the card scheme verifies whether the cardholder name matches the issuer’s records."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It helps confirm the cardholder’s identity, supporting the decision to approve, verify, or decline a transaction."},"children":[]}]}]}],"properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outcome of the name match check performed against the issuer’s records."},"children":[]}]}]}],"enum":["performed","not_performed","not_supported"],"example":"performed"},"full_name_match":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result of matching the full cardholder name against the issuer’s records."},"children":[]}]}]}],"enum":["matched","partially_matched","not_matched"],"example":"matched"},"first_name_match":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result of matching the cardholder’s first name against the issuer’s records."},"children":[]}]}]}],"enum":["matched","partially_matched","not_matched"],"example":"partially_matched"},"last_name_match":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result of matching the cardholder’s last name against the issuer’s records."},"children":[]}]}]}],"enum":["matched","partially_matched","not_matched"],"example":"not_matched"}}}},"components/schemas/SchemaCardsVerificationResult":{"id":"components/schemas/SchemaCardsVerificationResult","kind":"json-schema","title":"SchemaCardsVerificationResult","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification results for Address Verification Service ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/verification-result/#avs","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AVS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), Card Verification Value ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/verification-result/#cvv","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CVV"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and Account Name Inquiry ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/verification-result/#ani","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), providing match status."},"children":[]}]}]}],"properties":{"avs_result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AVS "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/verification-result/#avs","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"result"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from card schemes verifies if the billing address matches with the issuing bank."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It returns a value that indicates the level of match, assisting in the decision to approve, verify, or decline a transaction."},"children":[]}]}]}],"enum":["matched","partially_matched","not_matched","unsupported","unavailable","unknown"],"example":"matched"},"cvv_result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CVV "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/verification-result/#cvv","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"result"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates whether the CVV code entered matches the one on the card, confirming the cardholder’s possession."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It helps assess transaction legitimacy and decide whether to approve, verify, or decline."},"children":[]}]}]}],"enum":["matched","not_matched","not_checked","unavailable","unknown"],"example":"matched"},"ani":{"$ref":"#/components/schemas/SchemaCardsAniResult"}}}},"components/schemas/SchemaCardsChargebackFlow":{"id":"components/schemas/SchemaCardsChargebackFlow","kind":"json-schema","title":"SchemaCardsChargebackFlow","data":{"title":"SchemaCardsChargebackFlow","type":"object","description":"Map of chargebacks where the keys are chargeback identifiers.","required":["id","amount","dispute_amount","currency","type","status"],"properties":{"id":{"type":"integer","description":"Unique chargeback flow identifier."},"date":{"type":"string","description":"Datetime when the chargeback flow was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_date":{"type":"string","description":"Datetime when the chargeback flow was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"settlement_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Date when the chargeback flow was financially settled."},"deadline_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deadline for submitting a response to the dispute."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This corresponds to date + n, where n is a number of calendar days set by the scheme/acquirer."},"children":[]}]}]}]},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount involved in each stage of the chargeback process."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For example, there could be two records in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"chargeback_flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" one with an amount of 113.58 USD and another with an amount of 100 USD."},"children":[]}]}]}]},"dispute_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific amount disputed, typically in the smallest currency unit, that would be returned to the merchant if the dispute is resolved in their favor."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For example, if the second chargeback was successfully disputed, the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"dispute_amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" would be 100 USD."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the chargeback amount."},"children":[]}]}]}],"minLength":3,"maxLength":3},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#types","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback flow."},"children":[]}]}]}],"enum":["1st_chb","2nd_chb","arbitration"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback."},"children":[]}]}]}],"enum":["in_progress","document_sent","reversed","accepted","resolved","resolved_reversal"]},"arn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acquirer Reference Number (ARN) assigned to transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use ARN to check transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/SchemaCardsChargeback":{"id":"components/schemas/SchemaCardsChargeback","kind":"json-schema","title":"CardChargebackModel","data":{"title":"CardChargebackModel","type":"object","description":"Information about a chargeback, including identifiers, dates, amounts, status, and the flow of the chargeback process.","required":["id","dispute_date","amount","currency","chargeback_flow"],"properties":{"id":{"type":"integer","description":"Unique chargeback identifier.","example":12345},"dispute_date":{"type":"string","description":"Date when the chargeback was created by the issuer.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$ || ^\\d{4}-\\d{2}-\\d{2}","example":"2026-07-10 00:00:00"},"settlement_date":{"type":"string","description":"Date when the chargeback was financially settled.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2026-07-11 00:00:00"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount that will be deducted for the chargeback on a specific order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This amount may vary based on the user's decision to dispute a different amount."},"children":[]}]}]}],"example":100},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the chargeback amount."},"children":[]}]}]}],"maxLength":3,"minLength":3,"example":"USD"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#types","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback."},"children":[]}]}]}],"enum":["1st_chb","2nd_chb","arbitration"],"example":"2nd_chb"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback."},"children":[]}]}]}],"enum":["in_progress","document_sent","reversed","accepted","resolved","resolved_reversal"],"example":"reversed"},"reason_group":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/reason-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" group."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It could be used for the segmentation and analytic purposes."},"children":[]}]}]}],"example":"Fraud"},"reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/reason-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the chargeback provided by the card scheme."},"children":[]}]}]}],"example":"10.4"},"reason_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/reason-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" description for the chargeback provided by the card scheme."},"children":[]}]}]}],"example":"Fraud – Card-Absent Environment"},"chargeback_flow":{"type":"array","description":"Map of chargeback flows where the keys are chargeback flow identifiers.","items":{"$ref":"#/components/schemas/SchemaCardsChargebackFlow"}}}}},"components/schemas/SchemaCardsDeviceInfo":{"id":"components/schemas/SchemaCardsDeviceInfo","kind":"json-schema","title":"SchemaCardsDeviceInfo","data":{"title":"SchemaCardsDeviceInfo","type":"object","description":"Information about the device used.","properties":{"user_agent":{"type":"string","description":"Device user-agent.","minLength":1,"maxLength":1000}}}},"components/schemas/SchemaCardsPayForm":{"id":"components/schemas/SchemaCardsPayForm","kind":"json-schema","title":"CardPayFormModel","data":{"title":"CardPayFormModel","description":"Represents a payment form, including deprecated properties related to the form URL and token.","type":"object","properties":{"form_url":{"type":"string","deprecated":true,"description":"Payment form URL created for the order.","example":"https://example.com/pay_form_url"},"token":{"type":"string","deprecated":true,"description":"Secure payment token representing sensitive payment method information.","example":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}}}},"components/schemas/SchemaCardsPaymentAdviser":{"id":"components/schemas/SchemaCardsPaymentAdviser","kind":"json-schema","title":"SchemaCardsPaymentAdviser","data":{"title":"SchemaCardsPaymentAdviser","description":"Provides recommendations on which payment type to offer for future orders based on the card used.","type":"object","properties":{"advise":{"type":"string","description":"Recommendation for which payment type to use for the given order and card.","deprecated":true}}}},"components/schemas/ResponseCardsCharge":{"id":"components/schemas/ResponseCardsCharge","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsOrder"},{"type":"object","properties":{"product_id":{"type":"string","format":"uuid","maxLength":36,"minLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}]},"product_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"minLength":1,"maxLength":500},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"payment_method":{"enum":["card","network-token"]}}}]},"transaction":{"$ref":"#/components/schemas/SchemaCardsTransaction"},"transactions":{"type":"object","description":"Map of transactions where the keys are transaction identifiers.","properties":{"<transaction_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsTransaction"}},"required":["<transaction_id_value_#1>"]},"three_ds":{"$ref":"#/components/schemas/SchemaCardsThreeDs"},"routing":{"$ref":"#/components/schemas/SchemaCardsRouting"},"antifraud_result":{"$ref":"#/components/schemas/SchemaCardsAntifraudResult"},"verification_result":{"$ref":"#/components/schemas/SchemaCardsVerificationResult"},"chargebacks":{"type":"object","description":"Map of chargebacks where the keys are chargeback identifiers.","properties":{"<chargeback_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsChargeback"}}},"device_info":{"$ref":"#/components/schemas/SchemaCardsDeviceInfo"},"verify_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the customer should be redirected to complete 3DS authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Only after opening the URL and authenticating the order "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" change to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"redirect_url":{"type":"string","description":"URL where customer should be redirected after finishing 3D Secure or redirect payment method."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"pay_form":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPayForm"}]},"payment_adviser":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPaymentAdviser"}]}},"required":["order","transactions"]}},"components/schemas/ResponseMainAuthenticationFailed":{"id":"components/schemas/ResponseMainAuthenticationFailed","kind":"json-schema","title":"Authentication failed","data":{"title":"Authentication failed","type":"object","properties":{"error":{"description":"Error object.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#101-authentication-failed","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" due to invalid credentials."},"children":[]}]}]}],"default":1.01,"example":"1.01"},"messages":{"type":"array","description":"Array of error messages applied to the decline payment.","items":{"example":"Authentication failed"}}},"required":["code","messages"]}},"required":["error"]}},"components/schemas/SchemaMainErrorInvalidData":{"id":"components/schemas/SchemaMainErrorInvalidData","kind":"json-schema","title":"SchemaMainErrorInvalidData","data":{"title":"SchemaMainErrorInvalidData","type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicating the reason for the payment decline, specifically related to validation errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"These errors often suggest that the transaction data is incorrect or incomplete."},"children":[]}]}]}],"enum":["2.01"],"example":"2.01"},"messages":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array containing messages that specify why the payment was declined due to validation errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"These messages can range from an incorrect card number to an invalid security code or billing address."},"children":[]}]}]}],"items":{"type":"string","example":"Invalid data"}}},"required":["code","messages"]}},"components/schemas/SchemaMainErrorOrderNotFound":{"id":"components/schemas/SchemaMainErrorOrderNotFound","kind":"json-schema","title":"SchemaMainErrorOrderNotFound","data":{"title":"SchemaMainErrorOrderNotFound","type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" generated by the payment gateway, specifically indicating that the order was not found in the system."},"children":[]}]}]}],"enum":["2.01"],"example":"2.01"},"messages":{"type":"object","description":"Object containing key-value pairs that clarify the reason for the payment decline, particularly in cases where the requested order does not exist."}},"required":["code","messages"]}},"components/schemas/SchemaMainErrorCardBrandNotSupported":{"id":"components/schemas/SchemaMainErrorCardBrandNotSupported","kind":"json-schema","title":"SchemaMainErrorCardBrandNotSupported","data":{"title":"SchemaMainErrorCardBrandNotSupported","type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicating that the card brand does not support the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"incremental authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This error occurs when attempting to use incremental authorization with a card brand that does not support this feature."},"children":[]}]}]}],"enum":["2.04"],"example":"2.04"},"messages":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array containing messages that specify why the payment was declined due to unsupported card brand for incremental authorization."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supported card brands include American Express (Amex), Cartes Bancaires, Diners, Discover, JCB, Mastercard, Mexico Domestic (Network MX) and Visa."},"children":[]}]}]}],"items":{"type":"string","example":"Card brand is not supported"}}},"required":["code","messages"]}},"components/schemas/SchemaMainError":{"id":"components/schemas/SchemaMainError","kind":"json-schema","title":"SchemaMainError","data":{"title":"SchemaMainError","type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" representing the specific error or status condition."},"children":[]}]}]}],"enum":["X.XX"],"example":"X.XX"},"messages":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array containing either strings or objects that provide details about the error or status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"When it is an array of strings, each string describes a separate issue. When it is an object, the object will contain key-value pairs explaining the issue in more detail."},"children":[]}]}]}],"items":{"oneOf":[{"type":"string"},{"type":"object"}]}},"recommended_message_for_user":{"type":"string","description":"Message with recommended next steps or additional information.","example":"The user’s card balance has insufficient funds."}},"required":["code","messages"]}},"components/schemas/SchemaMainDiscriminatorError":{"id":"components/schemas/SchemaMainDiscriminatorError","kind":"json-schema","title":"SchemaMainDiscriminatorError","data":{"description":"Error object.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the declined payment."},"children":[]}]}]}]}},"discriminator":{"propertyName":"code","mapping":{"2.01 Invalid data":"#/components/schemas/SchemaMainErrorInvalidData","2.01 Order not found":"#/components/schemas/SchemaMainErrorOrderNotFound","2.04 Card brand is not supported":"#/components/schemas/SchemaMainErrorCardBrandNotSupported","X.XX":"#/components/schemas/SchemaMainError"}}}},"components/schemas/ResponseMainError":{"id":"components/schemas/ResponseMainError","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"error":{"$ref":"#/components/schemas/SchemaMainDiscriminatorError"}},"required":["error"]}},"components/schemas/SchemaCardsIndustryDataCarRental":{"id":"components/schemas/SchemaCardsIndustryDataCarRental","kind":"json-schema","title":"SchemaCardsIndustryDataCarRental","data":{"title":"SchemaCardsIndustryDataCarRental","type":"object","required":["type","car_rental"],"additionalProperties":false,"properties":{"type":{"type":"string","description":"Type of entity used to identify the classification of the data being provided.","enum":["car_rental"]},"car_rental":{"type":"object","description":"Car rental-related details.","required":["agreement_number","renter_name","pick_up_date","drop_off_date","refundability","return_location_id","pick_up_location","drop_off_location","distance_limit"],"additionalProperties":false,"properties":{"agreement_number":{"type":"string","description":"Rental agreement number for the car rental.","maxLength":9},"renter_name":{"type":"string","description":"Name of the person renting the car.","maxLength":26},"pick_up_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTC date and time of the rental pick-up in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date-time","example":"2026-03-01T11:00:00Z"},"drop_off_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTC date and time of the rental drop-off in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date-time","example":"2026-03-05T16:30:00Z"},"refundability":{"type":"string","description":"Indicates whether the booking is refundable, partially refundable, or non-refundable.","enum":["refundable","non_refundable","partially_refundable"]},"rate":{"type":"integer","description":"Daily rental rate in minor units.","minimum":0},"rate_indicator":{"type":"string","description":"Specifies whether the provided rate is daily or weekly.","enum":["D","W"]},"days_rented":{"type":"string","description":"Number of days for which the car is rented.","maxLength":4},"customer_service_toll_free_number":{"type":"string","description":"Customer service phone number of the car rental company.","maxLength":17},"rental_class_id":{"type":"string","description":"Classification of the rental car.","maxLength":4},"tax_exempt_indicator":{"type":"string","description":"Indicates whether goods or services were tax-exempt.","enum":["Y","N"]},"fuel_charges":{"type":"integer","description":"Fuel charges associated with the rental, in minor units.","minimum":0},"insurance_charges":{"type":"integer","description":"Insurance charges associated with the rental, in minor units.","minimum":0},"no_show_indicator":{"type":"string","description":"Indicates whether the customer did not pick up the rental car.","enum":["Y","N"]},"one_way_drop_off_charges":{"type":"integer","description":"Charge for returning a car to a location different from pick-up, in minor units.","minimum":0},"return_location_id":{"type":"string","description":"Agency code, phone number, or address abbreviation of the return location.","maxLength":10},"pick_up_location":{"type":"object","description":"Address where the car is picked up.","required":["state","city","country","postal"],"additionalProperties":false,"properties":{"street_line_1":{"type":"string","description":"Street line 1 where the car is picked up.","maxLength":100},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State or province where the car is picked up in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":2},"city":{"type":"string","description":"City where the car is picked up.","maxLength":100},"country":{"type":"string","description":"Country where the car is picked up.","format":"iso_code_a3","minLength":3,"maxLength":3},"postal":{"type":"string","description":"Postcode associated with the picked up location.","maxLength":10}}},"drop_off_location":{"type":"object","description":"Address where the car is dropped off.","required":["state","city","country","postal"],"additionalProperties":false,"properties":{"street_line_1":{"type":"string","description":"Street line 1 where the car is dropped off.","maxLength":100},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State or province where the car is dropped off in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":2},"city":{"type":"string","description":"City where the car is dropped off.","maxLength":100},"country":{"type":"string","description":"Country where the car is dropped off.","format":"iso_code_a3","minLength":3,"maxLength":3},"postal":{"type":"string","description":"Postcode associated with the dropped-off location.","maxLength":10}}},"distance_limit":{"type":"object","description":"Maximum allowed distance and cost for exceeding it.","required":["limit","unit","additional_distance_cost"],"additionalProperties":false,"properties":{"limit":{"type":"integer","description":"Maximum distance allowed.","minimum":0},"unit":{"type":"string","description":"Unit of distance.","enum":["miles","km"]},"additional_distance_cost":{"type":"object","description":"An additional cost is applied when the distance limit is exceeded.","required":["amount","currency"],"additionalProperties":false,"properties":{"amount":{"type":"integer","description":"Cost amount in the smallest currency unit.","minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3}}}}}}}}}},"components/schemas/SchemaCardsIndustryDataDiscriminatorCarRental":{"id":"components/schemas/SchemaCardsIndustryDataDiscriminatorCarRental","kind":"json-schema","title":"SchemaCardsIndustryDataDiscriminatorCarRental","data":{"title":"SchemaCardsIndustryDataDiscriminatorCarRental","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/industry-data/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industry-related"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data for car rental payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Applicable to merchants operating under car-rental-related MCCs 3351–3500, 7512, 7513, and 7519."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supplying this enriched data can help reduce fees, improve fraud detection and dispute handling, increase customer trust, and support industry compliance."},"children":[]}]}]}],"properties":{"type":{"type":"string"}},"discriminator":{"propertyName":"type","mapping":{"car_rental":"#/components/schemas/SchemaCardsIndustryDataCarRental"}}}},"components/schemas/SchemaCardsGooglePayEncrypted":{"id":"components/schemas/SchemaCardsGooglePayEncrypted","kind":"json-schema","title":"false","data":{"title":"false","type":"object","required":["order_id","amount","currency","order_description","customer_email","ip_address","platform","signature","signedMessage","protocolVersion","type"],"properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Google Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is valid only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow. If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the default fallback value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will be used. "},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the payment processing flow using "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]}],"default":false},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"industry_data":{"$ref":"#/components/schemas/SchemaCardsIndustryDataDiscriminatorCarRental"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"signature":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies that the message came from Google, base64-encoded and created using ECDSA by the intermediate signing key."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is taken from Google's response."},"children":[]}]}]}]},"signedMessage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON object serialized as an HTML-safe string that contains the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encryptedMessage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ephemeralPublicKey"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and tag. It is serialized to simplify the signature verification process."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is taken from Google's response."},"children":[]}]}]}]},"protocolVersion":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the encryption or signing scheme under which the message is created. It allows the protocol to evolve over time if needed. If it is not set, assume ECv0."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is taken from Google's response."},"children":[]}]}]}]},"network":{"type":"string","description":"Network (card brand) through which the payment is processed."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/SchemaCardsGooglePayDecryptedECv1Card":{"id":"components/schemas/SchemaCardsGooglePayDecryptedECv1Card","kind":"json-schema","title":"CARD","data":{"title":"CARD","type":"object","required":["pan","expirationMonth","expirationYear"],"properties":{"pan":{"type":"string","description":"Primary account number (PAN) charged.","minLength":12,"maxLength":19},"expirationMonth":{"type":"string","description":"PAN expiration month.","minLength":2,"maxLength":2},"expirationYear":{"type":"integer","description":"PAN expiration year.","minimum":1000,"maximum":9999}}}},"components/schemas/SchemaCardsGooglePayDecryptedECv1TokenizedCard":{"id":"components/schemas/SchemaCardsGooglePayDecryptedECv1TokenizedCard","kind":"json-schema","title":"TOKENIZED_CARD","data":{"title":"TOKENIZED_CARD","type":"object","required":["dpan","expirationMonth","expirationYear","authMethod","3dsCryptogram"],"properties":{"dpan":{"type":"string","description":"Digital primary account number (DPAN) or device token of primary account number (PAN) charged.","minLength":12,"maxLength":19},"expirationMonth":{"type":"string","description":"DPAN expiration month.","minLength":2,"maxLength":2},"expirationYear":{"type":"integer","description":"DPAN expiration year.","minimum":1000,"maximum":9999},"authMethod":{"type":"string","description":"Google Pay authorization method.","enum":["3DS"]},"3dsCryptogram":{"type":"string","description":"Base64 encoded cardholder authentication value (20 bytes in decoded form) used for validating the authentication result.","maxLength":100},"3dsEciIndicator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic Commerce Indicator ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/#eci-for-digital-wallets","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") level associated with the 3D Secure enrollment result."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide eci value for better transaction success rate."},"children":[]}]}]}],"minLength":1,"maxLength":2}}}},"components/schemas/SchemaCardsGooglePayDecryptedECv1":{"id":"components/schemas/SchemaCardsGooglePayDecryptedECv1","kind":"json-schema","title":"ECv1","data":{"title":"ECv1","type":"object","required":["messageExpiration","messageId","paymentMethod","paymentMethodDetails"],"properties":{"gatewayMerchantId":{"type":"string","description":"Your public API key for submitting a payment data request to the Google API.","maxLength":255},"messageExpiration":{"type":"string","description":"Timestamp set one week from the time of passing payload, formatted as a string of Unix epoch milliseconds.","example":"1507738377032"},"messageId":{"type":"string","description":"Message randomly generated for each payload by Google.","maxLength":255},"paymentMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method returned by Google Pay API in a signed and encrypted PaymentMethodToken payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Defines parameters of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paymentMethodDetails"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object."},"children":[]}]}]}],"enum":["CARD","TOKENIZED_CARD"]},"paymentMethodDetails":{"type":"object","description":"Payment method details returned by Google Pay API.","oneOf":[{"$ref":"#/components/schemas/SchemaCardsGooglePayDecryptedECv1Card"},{"$ref":"#/components/schemas/SchemaCardsGooglePayDecryptedECv1TokenizedCard"}]}}}},"components/schemas/SchemaCardsGooglePayDecryptedECv2PanOnly":{"id":"components/schemas/SchemaCardsGooglePayDecryptedECv2PanOnly","kind":"json-schema","title":"PAN_ONLY","data":{"title":"PAN_ONLY","type":"object","required":["pan","expirationMonth","expirationYear","authMethod"],"properties":{"authMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Pay authorization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Defines parameters of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paymentMethodDetails"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object."},"children":[]}]}]}],"enum":["PAN_ONLY"]},"pan":{"type":"string","description":"Primary account number (PAN) charged.","minLength":12,"maxLength":19},"expirationMonth":{"type":"string","description":"PAN expiration month.","minLength":2,"maxLength":2},"expirationYear":{"type":"integer","description":"PAN expiration year.","minimum":1000,"maximum":9999}}}},"components/schemas/SchemaCardsGooglePayDecryptedECv2Cryptogram3DS":{"id":"components/schemas/SchemaCardsGooglePayDecryptedECv2Cryptogram3DS","kind":"json-schema","title":"CRYPTOGRAM_3DS","data":{"title":"CRYPTOGRAM_3DS","type":"object","required":["pan","expirationMonth","expirationYear","authMethod","3dsCryptogram"],"properties":{"authMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Pay authorization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Defines parameters of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paymentMethodDetails"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object."},"children":[]}]}]}],"enum":["CRYPTOGRAM_3DS"]},"3dsCryptogram":{"type":"string","description":"Base64 encoded cardholder authentication value (20 bytes in decoded form) used for validating the authentication result.","maxLength":100},"pan":{"type":"string","description":"Primary account number (PAN) charged.","minLength":12,"maxLength":19},"expirationMonth":{"type":"string","description":"PAN expiration month.","minLength":2,"maxLength":2},"expirationYear":{"type":"integer","description":"PAN expiration year.","minimum":1000,"maximum":9999},"3dsEciIndicator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic Commerce Indicator ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/#eci-for-digital-wallets","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") level associated with the 3D Secure enrollment result."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide eci value for better transaction success rate."},"children":[]}]}]}],"minLength":1,"maxLength":2}}}},"components/schemas/SchemaCardsGooglePayDecryptedECv2":{"id":"components/schemas/SchemaCardsGooglePayDecryptedECv2","kind":"json-schema","title":"ECv2","data":{"title":"ECv2","type":"object","required":["messageExpiration","messageId","paymentMethod","paymentMethodDetails"],"properties":{"gatewayMerchantId":{"type":"string","description":"Your public API key for submitting a payment data request to the Google API.","maxLength":255},"messageExpiration":{"type":"string","description":"A timestamp set one week from the time of passing payload, formatted as a string of Unix epoch milliseconds.","example":"1507738377032"},"messageId":{"type":"string","description":"Message randomly generated for each payload by Google.","maxLength":255},"paymentMethod":{"type":"string","description":"Payment method returned by Google Pay API in a signed and encrypted PaymentMethodToken payload.","enum":["CARD"]},"paymentMethodDetails":{"type":"object","description":"Payment method details returned by Google Pay API.","oneOf":[{"$ref":"#/components/schemas/SchemaCardsGooglePayDecryptedECv2PanOnly"},{"$ref":"#/components/schemas/SchemaCardsGooglePayDecryptedECv2Cryptogram3DS"}]}}}},"components/schemas/SchemaCardsGooglePayDecrypted":{"id":"components/schemas/SchemaCardsGooglePayDecrypted","kind":"json-schema","title":"true","data":{"title":"true","type":"object","required":["decrypted_data","order_id","amount","currency","order_description","customer_email","protocolVersion","ip_address","platform","type"],"properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Google Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false},"decrypted_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with decrypted Google Pay payment data."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Requires"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" the request to include "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Please note that "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"decrypted_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" parameters are defined and validated based on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"protocolVersion"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" value, which are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ECv1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ECv2"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaCardsGooglePayDecryptedECv1"},{"$ref":"#/components/schemas/SchemaCardsGooglePayDecryptedECv2"}]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is valid only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow. If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the default fallback value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will be used. "},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the payment processing flow using "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]}],"default":false},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"industry_data":{"$ref":"#/components/schemas/SchemaCardsIndustryDataDiscriminatorCarRental"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"protocolVersion":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the encryption or signing scheme under which the message is created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expected values are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECv1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECv2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which define the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is taken from Google's response."},"children":[]}]}]}],"enum":["ECv1","ECv2"]},"network":{"type":"string","description":"Network (card brand) through which the payment is processed."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/RequestCardsGooglePay":{"id":"components/schemas/RequestCardsGooglePay","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Google Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false}},"discriminator":{"propertyName":"is_decrypted","mapping":{"false":"#/components/schemas/SchemaCardsGooglePayEncrypted","true":"#/components/schemas/SchemaCardsGooglePayDecrypted"}}}},"components/schemas/SchemaCardsProductBasedPaymentGooglePayEncrypted":{"id":"components/schemas/SchemaCardsProductBasedPaymentGooglePayEncrypted","kind":"json-schema","title":"false","data":{"title":"false","type":"object","required":["product_id","order_id","order_description","customer_email","customer_account_id","ip_address","platform","signature","signedMessage","protocolVersion","type"],"properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Google Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the payment processing flow using "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]}],"default":false},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"signature":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies that the message came from Google, base64-encoded and created using ECDSA by the intermediate signing key."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is taken from Google's response."},"children":[]}]}]}]},"signedMessage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON object serialized as an HTML-safe string that contains the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encryptedMessage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ephemeralPublicKey"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and tag. It is serialized to simplify the signature verification process."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is taken from Google's response."},"children":[]}]}]}]},"protocolVersion":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the encryption or signing scheme under which the message is created. It allows the protocol to evolve over time if needed. If it is not set, assume ECv0."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is taken from Google's response."},"children":[]}]}]}]},"network":{"type":"string","description":"Network (card brand) through which the payment is processed."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/SchemaCardsProductBasedPaymentGooglePayDecrypted":{"id":"components/schemas/SchemaCardsProductBasedPaymentGooglePayDecrypted","kind":"json-schema","title":"true","data":{"title":"true","type":"object","required":["decrypted_data","product_id","order_id","order_description","customer_email","protocolVersion","customer_account_id","ip_address","platform","type"],"properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Google Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false},"decrypted_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with decrypted Google Pay payment data."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Requires"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" the request to include "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Please note that "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"decrypted_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" parameters are defined and validated based on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"protocolVersion"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" value, which are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ECv1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ECv2"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaCardsGooglePayDecryptedECv1"},{"$ref":"#/components/schemas/SchemaCardsGooglePayDecryptedECv2"}]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the payment processing flow using "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]}],"default":false},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For format consistency, it is recommended to adhere to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"protocolVersion":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the encryption or signing scheme under which the message is created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expected values are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECv1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECv2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which define the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is taken from Google's response."},"children":[]}]}]}],"enum":["ECv1","ECv2"]},"network":{"type":"string","description":"Network (card brand) through which the payment is processed."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/RequestCardsProductBasedPaymentGooglePay":{"id":"components/schemas/RequestCardsProductBasedPaymentGooglePay","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","type":"object","properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Google Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false}},"discriminator":{"propertyName":"is_decrypted","mapping":{"false":"#/components/schemas/SchemaCardsProductBasedPaymentGooglePayEncrypted","true":"#/components/schemas/SchemaCardsProductBasedPaymentGooglePayDecrypted"}}}},"components/schemas/SchemaCardsSubscriptionPaymentGooglePayEncrypted":{"id":"components/schemas/SchemaCardsSubscriptionPaymentGooglePayEncrypted","kind":"json-schema","title":"false","data":{"title":"false","type":"object","required":["product_id","order_id","order_description","customer_email","customer_account_id","ip_address","platform","signature","signedMessage","protocolVersion","type"],"properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Google Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the payment processing flow using "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of retry attempts for the subscription payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use it for analytics and conversion tuning purposes."},"children":[]}]}]}],"minimum":0},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]}],"default":false},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For format consistency, it is recommended to adhere to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"signature":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies that the message came from Google, base64-encoded and created using ECDSA by the intermediate signing key."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is taken from Google's response."},"children":[]}]}]}]},"signedMessage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON object serialized as an HTML-safe string that contains the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encryptedMessage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ephemeralPublicKey"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and tag. It is serialized to simplify the signature verification process."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is taken from Google's response."},"children":[]}]}]}]},"protocolVersion":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the encryption or signing scheme under which the message is created. It allows the protocol to evolve over time if needed. If it is not set, assume ECv0."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is taken from Google's response."},"children":[]}]}]}]},"network":{"type":"string","description":"Network (card brand) through which the payment is processed."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/SchemaCardsSubscriptionPaymentGooglePayDecrypted":{"id":"components/schemas/SchemaCardsSubscriptionPaymentGooglePayDecrypted","kind":"json-schema","title":"true","data":{"title":"true","type":"object","required":["decrypted_data","product_id","order_id","order_description","customer_email","protocolVersion","customer_account_id","ip_address","platform","type"],"properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Google Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false},"decrypted_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with decrypted Google Pay payment data."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Requires"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" the request to include "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Please note that "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"decrypted_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" parameters are defined and validated based on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"protocolVersion"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" value, which are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ECv1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ECv2"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaCardsGooglePayDecryptedECv1"},{"$ref":"#/components/schemas/SchemaCardsGooglePayDecryptedECv2"}]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the payment processing flow using "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of retry attempts for the subscription payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use it for analytics and conversion tuning purposes."},"children":[]}]}]}],"minimum":0},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]}],"default":false},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"protocolVersion":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the encryption or signing scheme under which the message is created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expected values are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECv1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECv2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which define the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is taken from Google's response."},"children":[]}]}]}],"enum":["ECv1","ECv2"]},"network":{"type":"string","description":"Network (card brand) through which the payment is processed."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/RequestCardsSubscriptionPaymentGooglePay":{"id":"components/schemas/RequestCardsSubscriptionPaymentGooglePay","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","type":"object","properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Google Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false}},"discriminator":{"propertyName":"is_decrypted","mapping":{"false":"#/components/schemas/SchemaCardsSubscriptionPaymentGooglePayEncrypted","true":"#/components/schemas/SchemaCardsSubscriptionPaymentGooglePayDecrypted"}}}},"components/schemas/ResponseCardsGooglePay":{"id":"components/schemas/ResponseCardsGooglePay","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsOrder"},{"type":"object","properties":{"product_id":{"type":"string","format":"uuid","maxLength":36,"minLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}]},"product_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"minLength":1,"maxLength":500},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"payment_method":{"enum":["google-pay"]}}}]},"transaction":{"$ref":"#/components/schemas/SchemaCardsTransaction"},"transactions":{"type":"object","description":"Map of transactions where the keys are transaction identifiers.","properties":{"<transaction_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsTransaction"}},"required":["<transaction_id_value_#1>"]},"three_ds":{"$ref":"#/components/schemas/SchemaCardsThreeDs"},"routing":{"$ref":"#/components/schemas/SchemaCardsRouting"},"antifraud_result":{"$ref":"#/components/schemas/SchemaCardsAntifraudResult"},"verification_result":{"$ref":"#/components/schemas/SchemaCardsVerificationResult"},"chargebacks":{"type":"object","description":"Map of chargebacks where the keys are chargeback identifiers.","properties":{"<chargeback_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsChargeback"}}},"device_info":{"$ref":"#/components/schemas/SchemaCardsDeviceInfo"},"verify_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the customer should be redirected to complete 3DS authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Only after opening the URL and authenticating the order "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" change to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"redirect_url":{"type":"string","description":"URL where customer should be redirected after finishing 3D Secure or redirect payment method."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"pay_form":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPayForm"}]},"payment_adviser":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPaymentAdviser"}]}},"required":["order","transactions"]}},"components/schemas/SchemaCardsApplePayEncrypted":{"id":"components/schemas/SchemaCardsApplePayEncrypted","kind":"json-schema","title":"false","data":{"title":"false","type":"object","required":["order_id","amount","currency","order_description","customer_email","ip_address","platform","data","header","signature","version","type"],"properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Apple Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is valid only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow. If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the default fallback value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will be used. "},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"industry_data":{"$ref":"#/components/schemas/SchemaCardsIndustryDataDiscriminatorCarRental"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":"Color depth of the customer browser during the payment."},"browser_screen_height":{"type":"integer","description":"Screen height of the customer browser during the payment."},"browser_screen_width":{"type":"integer","description":"Screen width of the customer browser during the payment."},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]}]},"user_agent":{"type":"string","description":"Device user-agent.","minLength":1,"maxLength":1000},"data":{"type":"string","description":"Encrypted payment data, Base64 encoded as a string."},"signature":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature of the payment and header data."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The signature includes the signing certificate, its intermediate CA certificate, and information about the signing algorithm."},"children":[]}]}]}]},"version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version information about the payment token."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Token uses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EC_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for ECC-encrypted data and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RSA_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for RSA-encrypted data."},"children":[]}]}]}]},"network":{"type":"string","description":"Network (card brand) through which the payment is processed."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"header":{"type":"object","required":["transactionId","publicKeyHash"],"description":"Additional version-dependent information used to decrypt and verify the payment.","properties":{"transactionId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction identifier generated on the device."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"applicationData":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash of the X.509 encoded public key bytes of the merchant’s certificate."},"children":[]}]}]}]},"ephemeralPublicKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ephemeral public key bytes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the version is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EC_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only."},"children":[]}]}]}]},"publicKeyHash":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicationData"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the original "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PKPaymentRequest"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},"wrappedKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Symmetric key wrapped using your RSA public key."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the version is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RSA_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only."},"children":[]}]}]}]}}},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/SchemaCardsApplePayDecrypted3DSecure":{"id":"components/schemas/SchemaCardsApplePayDecrypted3DSecure","kind":"json-schema","title":"3DSecure","data":{"title":"3DSecure","type":"object","required":["onlinePaymentCryptogram"],"properties":{"onlinePaymentCryptogram":{"type":"string","description":"Base64 encoded cardholder authentication value (20 bytes in decoded form) used for validating the authentication result.","maxLength":100},"eciIndicator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic Commerce Indicator ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/#eci-for-digital-wallets","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") level associated with the 3D Secure enrollment result."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide eci value for better transaction success rate."},"children":[]}]}]}],"minLength":1,"maxLength":2}}}},"components/schemas/SchemaCardsApplePayDecryptedEMV":{"id":"components/schemas/SchemaCardsApplePayDecryptedEMV","kind":"json-schema","title":"EMV","data":{"title":"EMV","type":"object","required":["emvData"],"properties":{"emvData":{"type":"string","description":"EMV chip data."},"encryptedPINData":{"type":"string","description":"Encrypted cardholder's PIN data."}}}},"components/schemas/SchemaCardsApplePayDecrypted":{"id":"components/schemas/SchemaCardsApplePayDecrypted","kind":"json-schema","title":"true","data":{"title":"true","type":"object","required":["decrypted_data","order_id","amount","currency","order_description","customer_email","ip_address","platform","header","type"],"properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Apple Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false},"decrypted_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with decrypted Apple Pay payment data."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Requires"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" the request to include "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":".\n"},"children":[]}]}],"required":["applicationPrimaryAccountNumber","applicationExpirationDate","currencyCode","transactionAmount","deviceManufacturerIdentifier","paymentDataType","paymentData"],"properties":{"applicationPrimaryAccountNumber":{"type":"string","description":"Primary account number (PAN) of the card that funds the transaction.","minLength":12,"maxLength":19},"applicationExpirationDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAN expiration date in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YYMMDD"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"YYMMDD","example":"281231"},"currencyCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Apple Pay uses numeric code for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"currencyCode"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", for example, it sends "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"840"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" instead of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"USD"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":3,"maxLength":3},"transactionAmount":{"type":"integer","description":"Transaction amount.","minimum":0},"cardholderName":{"type":"string","description":"Cardholder's name as it appears on the card, which is essential for transaction processing.","minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$"},"deviceManufacturerIdentifier":{"type":"string","description":"Customer's device identifier.","maxLength":255},"paymentDataType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of payment data sent by Apple Pay."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Defines parameters of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paymentData"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object."},"children":[]}]}]}],"enum":["3DSecure","EMV"]},"paymentData":{"type":"object","description":"Additional payment data sent by Apple Pay.","oneOf":[{"$ref":"#/components/schemas/SchemaCardsApplePayDecrypted3DSecure"},{"$ref":"#/components/schemas/SchemaCardsApplePayDecryptedEMV"}]}}},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is valid only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow. If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the default fallback value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will be used. "},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"industry_data":{"$ref":"#/components/schemas/SchemaCardsIndustryDataDiscriminatorCarRental"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":"Color depth of the customer browser during the payment."},"browser_screen_height":{"type":"integer","description":"Screen height of the customer browser during the payment."},"browser_screen_width":{"type":"integer","description":"Screen width of the customer browser during the payment."},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]}]},"user_agent":{"type":"string","description":"Device user-agent.","minLength":1,"maxLength":1000},"version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version information about the payment token."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Token uses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EC_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for ECC-encrypted data and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RSA_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for RSA-encrypted data."},"children":[]}]}]}]},"network":{"type":"string","description":"Network (card brand) through which the payment is processed."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"header":{"type":"object","required":["transactionId","publicKeyHash"],"description":"Additional version-dependent information used to decrypt and verify the payment.","properties":{"transactionId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction identifier generated on the device."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"applicationData":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash of the X.509 encoded public key bytes of the merchant’s certificate."},"children":[]}]}]}]},"ephemeralPublicKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ephemeral public key bytes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the version is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EC_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only."},"children":[]}]}]}]},"publicKeyHash":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicationData"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the original "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PKPaymentRequest"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},"wrappedKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Symmetric key wrapped using your RSA public key."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the version is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RSA_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only."},"children":[]}]}]}]}}},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/RequestCardsApplePay":{"id":"components/schemas/RequestCardsApplePay","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Apple Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false}},"discriminator":{"propertyName":"is_decrypted","mapping":{"false":"#/components/schemas/SchemaCardsApplePayEncrypted","true":"#/components/schemas/SchemaCardsApplePayDecrypted"}}}},"components/schemas/SchemaCardsProductBasedPaymentApplePayEncrypted":{"id":"components/schemas/SchemaCardsProductBasedPaymentApplePayEncrypted","kind":"json-schema","title":"false","data":{"title":"false","type":"object","required":["order_id","product_id","order_description","customer_account_id","customer_email","ip_address","platform","data","header","signature","version","type"],"properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Apple Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":"Color depth of the customer browser during the payment."},"browser_screen_height":{"type":"integer","description":"Screen height of the customer browser during the payment."},"browser_screen_width":{"type":"integer","description":"Screen width of the customer browser during the payment."},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]}]},"user_agent":{"type":"string","description":"Device user-agent.","minLength":1,"maxLength":1000},"data":{"type":"string","description":"Encrypted payment data, Base64 encoded as a string."},"signature":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature of the payment and header data."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The signature includes the signing certificate, its intermediate CA certificate, and information about the signing algorithm."},"children":[]}]}]}]},"version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version information about the payment token."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Token uses `EC_v1` for ECC-encrypted data and `RSA_v1` for RSA-encrypted data."},"children":[]}]}]}]},"network":{"type":"string","description":"Network (card brand) through which the payment is processed."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"header":{"type":"object","required":["transactionId","publicKeyHash"],"description":"Additional version-dependent information used to decrypt and verify the payment.","properties":{"transactionId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction identifier generated on the device."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"applicationData":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash of the X.509 encoded public key bytes of the merchant’s certificate."},"children":[]}]}]}]},"ephemeralPublicKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ephemeral public key bytes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the version is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EC_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only."},"children":[]}]}]}]},"publicKeyHash":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicationData"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the original "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PKPaymentRequest"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},"wrappedKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Symmetric key wrapped using your RSA public key."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the version is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RSA_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only."},"children":[]}]}]}]}}},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/SchemaCardsProductBasedPaymentApplePayDecrypted":{"id":"components/schemas/SchemaCardsProductBasedPaymentApplePayDecrypted","kind":"json-schema","title":"true","data":{"title":"true","type":"object","required":["decrypted_data","order_id","product_id","order_description","customer_account_id","customer_email","header","ip_address","platform","type"],"properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Apple Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false},"decrypted_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with decrypted Apple Pay payment data."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Requires"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" the request to include "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":".\n"},"children":[]}]}],"required":["applicationPrimaryAccountNumber","applicationExpirationDate","currencyCode","transactionAmount","deviceManufacturerIdentifier","paymentDataType","paymentData"],"properties":{"applicationPrimaryAccountNumber":{"type":"string","description":"Primary account number (PAN) of the card that funds the transaction.","minLength":12,"maxLength":19},"applicationExpirationDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAN expiration date in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YYMMDD"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"YYMMDD","example":"281231"},"currencyCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Apple Pay uses numeric code for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"currencyCode"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", for example, it sends "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"840"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" instead of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"USD"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":3,"maxLength":3},"transactionAmount":{"type":"integer","description":"Transaction amount.","minimum":0},"cardholderName":{"type":"string","description":"Cardholder's name as it appears on the card, which is essential for transaction processing.","minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$"},"deviceManufacturerIdentifier":{"type":"string","description":"Customer's device identifier.","maxLength":255},"paymentDataType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of payment data sent by Apple Pay."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Defines parameters of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paymentData"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object."},"children":[]}]}]}],"enum":["3DSecure","EMV"]},"paymentData":{"type":"object","description":"Additional payment data sent by Apple Pay.","oneOf":[{"$ref":"#/components/schemas/SchemaCardsApplePayDecrypted3DSecure"},{"$ref":"#/components/schemas/SchemaCardsApplePayDecryptedEMV"}]}}},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":"Color depth of the customer browser during the payment."},"browser_screen_height":{"type":"integer","description":"Screen height of the customer browser during the payment."},"browser_screen_width":{"type":"integer","description":"Screen width of the customer browser during the payment."},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]}]},"user_agent":{"type":"string","description":"Device user-agent.","minLength":1,"maxLength":1000},"version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version information about the payment token."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Token uses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EC_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for ECC-encrypted data and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RSA_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for RSA-encrypted data."},"children":[]}]}]}]},"network":{"type":"string","description":"Network (card brand) through which the payment is processed."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"header":{"type":"object","required":["transactionId","publicKeyHash"],"description":"Additional version-dependent information used to decrypt and verify the payment.","properties":{"transactionId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction identifier generated on the device."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"applicationData":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash of the X.509 encoded public key bytes of the merchant’s certificate."},"children":[]}]}]}]},"ephemeralPublicKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ephemeral public key bytes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the version is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EC_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only."},"children":[]}]}]}]},"publicKeyHash":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicationData"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the original "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PKPaymentRequest"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},"wrappedKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Symmetric key wrapped using your RSA public key."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the version is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RSA_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only."},"children":[]}]}]}]}}},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/RequestCardsProductBasedPaymentApplePay":{"id":"components/schemas/RequestCardsProductBasedPaymentApplePay","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","type":"object","properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Apple Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false}},"discriminator":{"propertyName":"is_decrypted","mapping":{"false":"#/components/schemas/SchemaCardsProductBasedPaymentApplePayEncrypted","true":"#/components/schemas/SchemaCardsProductBasedPaymentApplePayDecrypted"}}}},"components/schemas/SchemaCardsSubscriptionPaymentApplePayEncrypted":{"id":"components/schemas/SchemaCardsSubscriptionPaymentApplePayEncrypted","kind":"json-schema","title":"false","data":{"title":"false","type":"object","required":["order_id","product_id","order_description","customer_account_id","customer_email","ip_address","platform","data","header","signature","version","type"],"properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Apple Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of retry attempts for the subscription payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use it for analytics and conversion tuning purposes."},"children":[]}]}]}],"minimum":0},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":"Color depth of the customer browser during the payment."},"browser_screen_height":{"type":"integer","description":"Screen height of the customer browser during the payment."},"browser_screen_width":{"type":"integer","description":"Screen width of the customer browser during the payment."},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]}]},"user_agent":{"type":"string","description":"Device user-agent.","minLength":1,"maxLength":1000},"data":{"type":"string","description":"Encrypted payment data, Base64 encoded as a string."},"signature":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature of the payment and header data."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The signature includes the signing certificate, its intermediate CA certificate, and information about the signing algorithm."},"children":[]}]}]}]},"version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version information about the payment token."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Token uses `EC_v1` for ECC-encrypted data and `RSA_v1` for RSA-encrypted data."},"children":[]}]}]}]},"network":{"type":"string","description":"Network (card brand) through which the payment is processed."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"header":{"type":"object","required":["transactionId","publicKeyHash"],"description":"Additional version-dependent information used to decrypt and verify the payment.","properties":{"transactionId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction identifier generated on the device."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"applicationData":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash of the X.509 encoded public key bytes of the merchant’s certificate."},"children":[]}]}]}]},"ephemeralPublicKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ephemeral public key bytes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the version is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EC_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only."},"children":[]}]}]}]},"publicKeyHash":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicationData"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the original "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PKPaymentRequest"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},"wrappedKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Symmetric key wrapped using your RSA public key."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the version is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RSA_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only."},"children":[]}]}]}]}}},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/SchemaCardsSubscriptionPaymentApplePayDecrypted":{"id":"components/schemas/SchemaCardsSubscriptionPaymentApplePayDecrypted","kind":"json-schema","title":"true","data":{"title":"true","type":"object","required":["decrypted_data","order_id","product_id","order_description","customer_account_id","customer_email","header","ip_address","platform","type"],"properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Apple Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false},"decrypted_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with decrypted Apple Pay payment data."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Requires"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" the request to include "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":".\n"},"children":[]}]}],"required":["applicationPrimaryAccountNumber","applicationExpirationDate","currencyCode","transactionAmount","deviceManufacturerIdentifier","paymentDataType","paymentData"],"properties":{"applicationPrimaryAccountNumber":{"type":"string","description":"Primary account number (PAN) of the card that funds the transaction.","minLength":12,"maxLength":19},"applicationExpirationDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAN expiration date in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YYMMDD"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"YYMMDD","example":"281231"},"currencyCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Apple Pay uses numeric code for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"currencyCode"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", for example, it sends "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"840"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" instead of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"USD"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":3,"maxLength":3},"transactionAmount":{"type":"integer","description":"Transaction amount.","minimum":0},"cardholderName":{"type":"string","description":"Cardholder's name as it appears on the card, which is essential for transaction processing.","minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$"},"deviceManufacturerIdentifier":{"type":"string","description":"Customer's device identifier.","maxLength":255},"paymentDataType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of payment data sent by Apple Pay."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Defines parameters of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paymentData"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object."},"children":[]}]}]}],"enum":["3DSecure","EMV"]},"paymentData":{"type":"object","description":"Additional payment data sent by Apple Pay.","oneOf":[{"$ref":"#/components/schemas/SchemaCardsApplePayDecrypted3DSecure"},{"$ref":"#/components/schemas/SchemaCardsApplePayDecryptedEMV"}]}}},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of retry attempts for the subscription payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use it for analytics and conversion tuning purposes."},"children":[]}]}]}],"minimum":0},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"city":{"type":"string","description":"Billing address city.","maxLength":100},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"maxLength":3,"minLength":3,"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":"Color depth of the customer browser during the payment."},"browser_screen_height":{"type":"integer","description":"Screen height of the customer browser during the payment."},"browser_screen_width":{"type":"integer","description":"Screen width of the customer browser during the payment."},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]}]},"user_agent":{"type":"string","description":"Device user-agent.","minLength":1,"maxLength":1000},"version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version information about the payment token."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Token uses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EC_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for ECC-encrypted data and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RSA_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for RSA-encrypted data."},"children":[]}]}]}]},"network":{"type":"string","description":"Network (card brand) through which the payment is processed."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"header":{"type":"object","required":["transactionId","publicKeyHash"],"description":"Additional version-dependent information used to decrypt and verify the payment.","properties":{"transactionId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction identifier generated on the device."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"applicationData":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash of the X.509 encoded public key bytes of the merchant’s certificate."},"children":[]}]}]}]},"ephemeralPublicKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ephemeral public key bytes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the version is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EC_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only."},"children":[]}]}]}]},"publicKeyHash":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicationData"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the original "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PKPaymentRequest"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},"wrappedKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Symmetric key wrapped using your RSA public key."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the version is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RSA_v1"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only."},"children":[]}]}]}]}}},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/RequestCardsSubscriptionPaymentApplePay":{"id":"components/schemas/RequestCardsSubscriptionPaymentApplePay","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","type":"object","properties":{"is_decrypted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payload received from Apple Pay was previously "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decrypted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false}},"discriminator":{"propertyName":"is_decrypted","mapping":{"false":"#/components/schemas/SchemaCardsSubscriptionPaymentApplePayEncrypted","true":"#/components/schemas/SchemaCardsSubscriptionPaymentApplePayDecrypted"}}}},"components/schemas/ResponseCardsApplePay":{"id":"components/schemas/ResponseCardsApplePay","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsOrder"},{"type":"object","properties":{"product_id":{"type":"string","format":"uuid","maxLength":36,"minLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}]},"product_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"minLength":1,"maxLength":500},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"payment_method":{"enum":["apple-pay"]}}}]},"transaction":{"$ref":"#/components/schemas/SchemaCardsTransaction"},"transactions":{"type":"object","description":"Map of transactions where the keys are transaction identifiers.","properties":{"<transaction_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsTransaction"}},"required":["<transaction_id_value_#1>"]},"three_ds":{"$ref":"#/components/schemas/SchemaCardsThreeDs"},"routing":{"$ref":"#/components/schemas/SchemaCardsRouting"},"antifraud_result":{"$ref":"#/components/schemas/SchemaCardsAntifraudResult"},"verification_result":{"$ref":"#/components/schemas/SchemaCardsVerificationResult"},"chargebacks":{"type":"object","description":"Map of chargebacks where the keys are chargeback identifiers.","properties":{"<chargeback_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsChargeback"}}},"device_info":{"$ref":"#/components/schemas/SchemaCardsDeviceInfo"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"pay_form":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPayForm"}]},"payment_adviser":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPaymentAdviser"}]}},"required":["order","transactions"]}},"components/schemas/RequestCardsIncrement":{"id":"components/schemas/RequestCardsIncrement","kind":"json-schema","title":"Payment incremental auth","data":{"title":"Payment incremental auth","type":"object","required":["order_id","amount"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Increment amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The amount represents the increment value to add to the initial authorization, not the total amount."},"children":[]}]}]}],"minimum":1}}}},"components/schemas/ResponseCardsIncrement":{"id":"components/schemas/ResponseCardsIncrement","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"transaction":{"type":"object","description":"Transaction details for the incremental authorization.","properties":{"id":{"type":"string","description":"Unique transaction identifier.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"amount":{"type":"integer","description":"Increment amount from the request in the smallest currency unit.","example":500},"currency":{"type":"string","description":"Currency code from the initial order.","example":"EUR"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"example":"processing"}}}}}},"components/schemas/RequestCardsRecurring":{"id":"components/schemas/RequestCardsRecurring","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","required":["order_id","amount","currency","order_description","recurring_token","customer_email","ip_address","platform","payment_type","type"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is valid only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow. If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the default fallback value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will be used. "},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for Apple Pay/Google Pay tokens."},"children":[]}]}]}],"enum":["1-click","recurring","retry","installment","rebill"]},"recurring_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token associated with a card method that could be used for subsequent payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not generated for all types of payment flows."},"children":[]}]}]}]},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and send it with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"external_mpi_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object, as it helps optimize payment success rates."},"children":[]}]}]}]},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersion"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"city":{"type":"string","description":"Billing address city.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/RequestCardsProductBasedPaymentRecurring":{"id":"components/schemas/RequestCardsProductBasedPaymentRecurring","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","type":"object","required":["product_id","order_id","order_description","recurring_token","customer_account_id","customer_email","ip_address","platform","payment_type","type"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for Apple Pay/Google Pay tokens."},"children":[]}]}]}],"enum":["1-click","recurring","retry","installment","rebill"]},"recurring_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token associated with a card method that could be used for subsequent payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not generated for all types of payment flows."},"children":[]}]}]}]},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and send it with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"external_mpi_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object, as it helps optimize payment success rates."},"children":[]}]}]}]},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersion"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"city":{"type":"string","description":"Billing address city.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/RequestCardsSubscriptionPaymentRecurring":{"id":"components/schemas/RequestCardsSubscriptionPaymentRecurring","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","type":"object","required":["product_id","order_id","order_description","recurring_token","customer_account_id","customer_email","ip_address","platform","payment_type","type"],"properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should not be"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" provided "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for Apple Pay/Google Pay tokens."},"children":[]}]}]}],"enum":["1-click","recurring","retry","installment","rebill"]},"recurring_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token associated with a card method that could be used for subsequent payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not generated for all types of payment flows."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of retry attempts for the subscription payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use it for analytics and conversion tuning purposes."},"children":[]}]}]}],"minimum":0},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and send it with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"external_mpi_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object, as it helps optimize payment success rates."},"children":[]}]}]}]},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersion"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"city":{"type":"string","description":"Billing address city.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/ResponseCardsRecurring":{"id":"components/schemas/ResponseCardsRecurring","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsOrder"},{"type":"object","properties":{"product_id":{"type":"string","format":"uuid","maxLength":36,"minLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}]},"product_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"minLength":1,"maxLength":500},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"payment_method":{"enum":["token"]}}}]},"transaction":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsTransaction"},{"type":"object","properties":{"card_token":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsCardToken"},{"type":"object","properties":{"original_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method used to capture the card credentials at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}],"enum":["card","apple-pay","google-pay","network-token","click-to-pay"],"example":"card"}}}]},"card":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsCard"},{"type":"object","properties":{"card_token":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsCardToken"},{"type":"object","properties":{"original_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method used to capture the card credentials at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}],"enum":["card","apple-pay","google-pay","network-token","click-to-pay"],"example":"card"}}}]}}}]}}}]},"transactions":{"type":"object","description":"Map of transactions where the keys are transaction identifiers.","properties":{"<transaction_id_value_#1>":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsTransaction"},{"type":"object","properties":{"card_token":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsCardToken"},{"type":"object","properties":{"original_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method used to capture the card credentials at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}],"enum":["card","apple-pay","google-pay","network-token","click-to-pay"],"example":"card"}}}]},"card":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsCard"},{"type":"object","properties":{"card_token":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsCardToken"},{"type":"object","properties":{"original_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method used to capture the card credentials at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}],"enum":["card","apple-pay","google-pay","network-token","click-to-pay"],"example":"card"}}}]}}}]}}}]}},"required":["<transaction_id_value_#1>"]},"three_ds":{"$ref":"#/components/schemas/SchemaCardsThreeDs"},"routing":{"$ref":"#/components/schemas/SchemaCardsRouting"},"antifraud_result":{"$ref":"#/components/schemas/SchemaCardsAntifraudResult"},"verification_result":{"$ref":"#/components/schemas/SchemaCardsVerificationResult"},"chargebacks":{"type":"object","description":"Map of chargebacks where the keys are chargeback identifiers.","properties":{"<chargeback_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsChargeback"}}},"device_info":{"$ref":"#/components/schemas/SchemaCardsDeviceInfo"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"pay_form":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPayForm"}]},"payment_adviser":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPaymentAdviser"}]}},"required":["order","transactions"]}},"components/schemas/RequestCardsResign":{"id":"components/schemas/RequestCardsResign","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","required":["order_id","amount","currency","order_description","recurring_token","customer_email","ip_address","platform","type"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is valid only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/zero-amount-authorization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zero-amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" flow. If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the default fallback value "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will be used. "},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final","estimated"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"recurring_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token associated with a card method that could be used for subsequent payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not generated for all types of payment flows."},"children":[]}]}]}]},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and send it with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"external_mpi_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object, as it helps optimize payment success rates."},"children":[]}]}]}]},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersion"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_cvv":{"type":"string","description":"Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.","pattern":"^[0-9]{3,4}$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"industry_data":{"$ref":"#/components/schemas/SchemaCardsIndustryDataDiscriminatorCarRental"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO 3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"city":{"type":"string","description":"Billing address city.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"maxLength":3,"minLength":3,"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" additional customer data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/RequestCardsProductBasedPaymentResign":{"id":"components/schemas/RequestCardsProductBasedPaymentResign","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","type":"object","required":["product_id","order_id","order_description","recurring_token","customer_account_id","customer_email","ip_address","platform","type"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief description of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"recurring_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token associated with a card method that could be used for subsequent payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not generated for all types of payment flows."},"children":[]}]}]}]},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and send it with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"external_mpi_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object, as it helps optimize payment success rates."},"children":[]}]}]}]},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersion"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_cvv":{"type":"string","description":"Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.","pattern":"^[0-9]{3,4}$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"city":{"type":"string","description":"Billing address city.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/RequestCardsSubscriptionPaymentResign":{"id":"components/schemas/RequestCardsSubscriptionPaymentResign","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","type":"object","required":["product_id","order_id","order_description","recurring_token","customer_account_id","customer_email","ip_address","platform","type"],"properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to keep the payment description under 100 characters for clarity."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":255},"order_items":{"type":"string","description":"Names and descriptions of the items included in the order."},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"order_number":{"type":"integer","format":"int32","description":"Sequential number of the order within the customer account."},"type":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#auth--settle","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"enum":["auth"]},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"240"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 10 days for Visa customer-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 5 days for Visa merchant-initiated payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"168"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hours = 7 days for all other card brands"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the responsibility for initiating the second stage of the payment via a separate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/settle-card-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request is on the API user."},"children":[]}]}]}],"maximum":240,"minimum":0},"authorization_type":{"type":"string","enum":["final"],"default":"final","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"recurring_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token associated with a card method that could be used for subsequent payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not generated for all types of payment flows."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of retry attempts for the subscription payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use it for analytics and conversion tuning purposes."},"children":[]}]}]}],"minimum":0},"force3ds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to force 3D Secure ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and send it with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"external_mpi_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object, as it helps optimize payment success rates."},"children":[]}]}]}]},"external_mpi_data":{"$ref":"#/components/schemas/SchemaCardsExternalMpiDsVersion"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number, including the country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"card_cvv":{"type":"string","description":"Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.","pattern":"^[0-9]{3,4}$"},"dynamic_descriptor":{"$ref":"#/components/schemas/SchemaCardsDynamicDescriptor"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"transaction_source":{"type":"string","description":"Identifies the internal system or flow that triggered the transaction.","maxLength":255},"purchase_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the goods are purchased in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to specify if you are registered as a marketplace with international payment systems."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Being a marketplace means you operate a platform where multiple sellers offer goods or services."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","default":"GBR","format":"iso_code_a3","maxLength":3,"minLength":3},"geo_city":{"type":"string","description":"City where the customer account is registered on the merchant platform.","maxLength":100},"country":{"type":"string","description":"Billing address country.","format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":10},"city":{"type":"string","description":"Billing address city.","maxLength":100},"zip_code":{"type":"string","description":"Postal code of the cardholder's billing address.","maxLength":10},"address":{"type":"string","description":"First and second line of the billing address.","maxLength":100},"shipping_address":{"$ref":"#/components/schemas/SchemaCardsShippingAddressAppleGoogle"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"website":{"type":"string","description":"Website from which payment is originated.","maxLength":255},"device":{"type":"string","description":"Name and model of the device.","maxLength":50},"device_sessions":{"$ref":"#/components/schemas/SchemaCardsDeviceSessions"},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"header_accept":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual content of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header as sent by the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"header_accept_language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String indicating the language of the browser, obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the client browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to follow the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/bcp47","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IETF BCP 47"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" language tag standards for format consistency."},"children":[]}]}]}]},"browser_color_depth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color depth of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_screen_width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width of the customer browser during the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"browser_java_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents the browser capacity to execute Java. The value is the one returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function, it can be true or false."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"time_zone_offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device user-agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3D Secure 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"force3ds"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments in specific locations."},"children":[]}]}]}]},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}}},"components/schemas/ResponseCardsResign":{"id":"components/schemas/ResponseCardsResign","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsOrder"},{"type":"object","properties":{"product_id":{"type":"string","format":"uuid","maxLength":36,"minLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}]},"product_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"minLength":1,"maxLength":500},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"payment_method":{"enum":["card"]}}}]},"transaction":{"$ref":"#/components/schemas/SchemaCardsTransaction"},"transactions":{"type":"object","description":"Map of transactions where the keys are transaction identifiers.","properties":{"<transaction_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsTransaction"}},"required":["<transaction_id_value_#1>"]},"three_ds":{"$ref":"#/components/schemas/SchemaCardsThreeDs"},"routing":{"$ref":"#/components/schemas/SchemaCardsRouting"},"antifraud_result":{"$ref":"#/components/schemas/SchemaCardsAntifraudResult"},"verification_result":{"$ref":"#/components/schemas/SchemaCardsVerificationResult"},"chargebacks":{"type":"object","description":"Map of chargebacks where the keys are chargeback identifiers.","properties":{"<chargeback_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsChargeback"}}},"device_info":{"$ref":"#/components/schemas/SchemaCardsDeviceInfo"},"verify_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the customer should be redirected to complete 3DS authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Only after opening the URL and authenticating the order "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" change to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"redirect_url":{"type":"string","description":"URL where customer should be redirected after finishing 3D Secure or redirect payment method."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"pay_form":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPayForm"}]},"payment_adviser":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPaymentAdviser"}]}},"required":["order","transactions"]}},"components/schemas/RequestCardsRefund":{"id":"components/schemas/RequestCardsRefund","kind":"json-schema","title":"CardRequestRefund","data":{"title":"CardRequestRefund","type":"object","properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"refund_reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code representing the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/refund-reasons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reason"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This code is used to identify the reason for both "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" transactions "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"operation"},"children":[]}]}]}]}],"minLength":4,"maxLength":4}},"required":["amount","order_id"]}},"components/schemas/ResponseCardsRefund":{"id":"components/schemas/ResponseCardsRefund","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsOrder"},{"type":"object","properties":{"product_id":{"type":"string","format":"uuid","maxLength":36,"minLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}]},"product_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"minLength":1,"maxLength":500},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"payment_method":{"enum":["card","network-token","token","apple-pay","google-pay"]}}}]},"transaction":{"$ref":"#/components/schemas/SchemaCardsTransaction"},"transactions":{"type":"object","description":"Map of transactions where the keys are transaction identifiers.","properties":{"<transaction_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsTransaction"}},"required":["<transaction_id_value_#1>"]},"three_ds":{"$ref":"#/components/schemas/SchemaCardsThreeDs"},"routing":{"$ref":"#/components/schemas/SchemaCardsRouting"},"antifraud_result":{"$ref":"#/components/schemas/SchemaCardsAntifraudResult"},"verification_result":{"$ref":"#/components/schemas/SchemaCardsVerificationResult"},"chargebacks":{"type":"object","description":"Map of chargebacks where the keys are chargeback identifiers.","properties":{"<chargeback_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsChargeback"}}},"device_info":{"$ref":"#/components/schemas/SchemaCardsDeviceInfo"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"pay_form":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPayForm"}]},"payment_adviser":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPaymentAdviser"}]}},"required":["order","transactions"]}},"components/schemas/RequestCardsVoid":{"id":"components/schemas/RequestCardsVoid","kind":"json-schema","title":"RequestCardsVoid","data":{"title":"RequestCardsVoid","type":"object","properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255,"example":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55"}},"required":["order_id"]}},"components/schemas/ResponseCardsVoid":{"id":"components/schemas/ResponseCardsVoid","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsOrder"},{"type":"object","properties":{"product_id":{"type":"string","format":"uuid","maxLength":36,"minLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}]},"product_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"minLength":1,"maxLength":500},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"payment_method":{"enum":["card","network-token","token","apple-pay","google-pay"]}}}]},"transaction":{"$ref":"#/components/schemas/SchemaCardsTransaction"},"transactions":{"type":"object","description":"Map of transactions where the keys are transaction identifiers.","properties":{"<transaction_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsTransaction"}},"required":["<transaction_id_value_#1>"]},"three_ds":{"$ref":"#/components/schemas/SchemaCardsThreeDs"},"routing":{"$ref":"#/components/schemas/SchemaCardsRouting"},"antifraud_result":{"$ref":"#/components/schemas/SchemaCardsAntifraudResult"},"verification_result":{"$ref":"#/components/schemas/SchemaCardsVerificationResult"},"chargebacks":{"type":"object","description":"Map of chargebacks where the keys are chargeback identifiers.","properties":{"<chargeback_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsChargeback"}}},"device_info":{"$ref":"#/components/schemas/SchemaCardsDeviceInfo"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"pay_form":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPayForm"}]},"payment_adviser":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPaymentAdviser"}]}},"required":["order","transactions"]}},"components/schemas/RequestCardsSettle":{"id":"components/schemas/RequestCardsSettle","kind":"json-schema","title":"CardRequestSettle","data":{"title":"CardRequestSettle","type":"object","properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255,"example":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0,"example":1020}},"required":["amount","order_id"]}},"components/schemas/ResponseCardsSettle":{"id":"components/schemas/ResponseCardsSettle","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsOrder"},{"type":"object","properties":{"product_id":{"type":"string","format":"uuid","maxLength":36,"minLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}]},"product_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"minLength":1,"maxLength":500},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"payment_method":{"enum":["card","network-token","token","apple-pay","google-pay"]}}}]},"transaction":{"$ref":"#/components/schemas/SchemaCardsTransaction"},"transactions":{"type":"object","description":"Map of transactions where the keys are transaction identifiers.","properties":{"<transaction_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsTransaction"}},"required":["<transaction_id_value_#1>"]},"three_ds":{"$ref":"#/components/schemas/SchemaCardsThreeDs"},"routing":{"$ref":"#/components/schemas/SchemaCardsRouting"},"antifraud_result":{"$ref":"#/components/schemas/SchemaCardsAntifraudResult"},"verification_result":{"$ref":"#/components/schemas/SchemaCardsVerificationResult"},"chargebacks":{"type":"object","description":"Map of chargebacks where the keys are chargeback identifiers.","properties":{"<chargeback_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsChargeback"}}},"device_info":{"$ref":"#/components/schemas/SchemaCardsDeviceInfo"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"pay_form":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPayForm"}]},"payment_adviser":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPaymentAdviser"}]}},"required":["order","transactions"]}},"components/schemas/RequestCardsStatus":{"id":"components/schemas/RequestCardsStatus","kind":"json-schema","title":"RequestOrderId","data":{"title":"RequestOrderId","type":"object","properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255,"example":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55"}},"required":["order_id"]}},"components/schemas/SchemaCardsErrorDoNotHonor":{"id":"components/schemas/SchemaCardsErrorDoNotHonor","kind":"json-schema","title":"SchemaMainErrorDoNotHonor","data":{"title":"SchemaMainErrorDoNotHonor","type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicating the reason for the payment decline, specifically related to validation errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"These errors often indicate that the card has been declined for an unknown reason."},"children":[]}]}]}],"enum":["3.08"],"example":"3.08"},"messages":{"type":"array","description":"Array containing messages that specify why the payment was declined due to validation errors.","items":{"type":"string","example":"Do not honor"}},"recommended_message_for_user":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended message to be displayed to the user for further action or information."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction."},"children":[]}]}]}]}},"required":["code","messages"]}},"components/schemas/SchemaCardsDiscriminatorErrorSuccess":{"id":"components/schemas/SchemaCardsDiscriminatorErrorSuccess","kind":"json-schema","title":"SchemaCardsDiscriminatorErrorSuccess","data":{"description":"Error object.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the declined payment."},"children":[]}]}]}]}},"discriminator":{"propertyName":"code","mapping":{"3.08 Do not honor":"#/components/schemas/SchemaCardsErrorDoNotHonor","X.XX":"#/components/schemas/SchemaCardsError"}}}},"components/schemas/ResponseCardsStatus":{"id":"components/schemas/ResponseCardsStatus","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"order":{"type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","required":["amount","currency","order_id","refunded_amount","status"],"properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255,"example":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55"},"order_description":{"type":"string","description":"Brief order description.","maxLength":255,"example":"Premium package"},"psp_order_id":{"type":"string","description":"PSP identifier generated by Solidgate."},"provider_payment_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PSP identifier generated by the PSP."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Value will be if the integration transmitted this data."},"children":[]}]}]}]},"product_id":{"type":"string","format":"uuid","maxLength":36,"minLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}]},"product_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"minLength":1,"maxLength":500},"subscription_id":{"type":"string","description":"Unique subscription identifier.","format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-4df0-899a-dda84fd2705e"},"invoice_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique invoice identifier associated with the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Retrieve invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/v2/invoices","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invoices"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" API V2."},"children":[]}]}]}],"maxLength":100,"example":"inv_01KPWT0K1PQWEYYRT7J1H3NC85"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This is the intended initial authorization amount."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\nexample: 100"},"children":[]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"processing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of the payment in the smallest currency unit as it was processed by the payment service provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This amount may differ from the original order amount due to currency conversion or other processing factors."},"children":[]}]}]}]},"processing_currency":{"type":"string","minLength":3,"maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the payment when it was processed by payment service provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In some cases, it is different from the original currency."},"children":[]}]}]}],"example":"USD"},"marketing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This is based on the intended initial authorization amount."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It should not be considered financial information, but it can be used for forecasting."},"children":[]}]}]}]},"marketing_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the currency used for calculation of marketing amount."},"children":[]}]}]}],"example":"USD"},"refunded_amount":{"description":"Indicates the amount that has been already refunded.","type":"integer"},"authorized_amount":{"type":"integer","description":"Total authorized amount of the order."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In the case of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"error"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object will be returned at the order level in the response."},"children":[]}]}]}],"enum":["processing","3ds_verify","refunded","auth_ok","auth_failed","settle_ok","partial_settled","void_ok"],"example":"processing"},"auth_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction authorization code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It can be empty if the provider does not pass a value."},"children":[]}]}]}],"example":"2w9m8"},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]}],"enum":["1-click","recurring","retry","installment","rebill","moto"]},"payment_method":{"type":"string","description":"Payment method used for the transaction.","enum":["card","network-token","token","apple-pay","google-pay"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100,"example":"example@example.com"},"descriptor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying text that appears on a customer’s credit or debit card statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It includes information about the transaction and helps the cardholder recognize the charge."},"children":[]}]}]}],"example":"google.com"},"mid":{"type":"string","description":"Merchant identifier in Solidgate.","example":"bank-mid-1"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255,"example":"facebook"},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}},"error":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Returned only in cases of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status at the order, and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"fail"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status at transaction."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/SchemaCardsDiscriminatorErrorSuccess"}]},"transaction":{"type":"object","description":"Details of a card transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.","required":["amount","card","created_at","currency","id","operation","status","updated_at"],"properties":{"id":{"type":"string","description":"Unique transaction identifier.","example":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2026-07-15 11:45:30"},"updated_at":{"type":"string","description":"Datetime when the transaction was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2026-07-16 11:45:30"},"amount":{"type":"integer","description":"Transaction amount.","example":100},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the transaction."},"children":[]}]}]}],"maxLength":3,"minLength":3,"example":"USD"},"marketing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It should not be considered financial information, but it can be used for forecasting."},"children":[]}]}]}]},"marketing_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the currency used for calculation of marketing amount."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["recurring-auth","refund","resign-auth","auth","settle","void","apple-pay","google-pay"],"example":"auth"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In the case of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"fail"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"error"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object will be returned at the transaction level in the response."},"children":[]}]}]}],"enum":["processing","success","fail","verify"],"example":"success"},"authorization_type":{"type":"string","enum":["final","estimated","incremental"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"scheme_transaction_id":{"type":"string","description":"Card-scheme transaction identifier linking this transaction to the original customer-initiated payment."},"transaction_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Link Identifier ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is an ID generated by Mastercard to link lifecycle activity after the original transaction."},"children":[]}]}]}],"maxLength":255},"descriptor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying text that appears on a customer’s credit or debit card statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It includes information about the transaction and helps the cardholder recognize the charge."},"children":[]}]}]}],"example":"google.com"},"billing_details":{"$ref":"#/components/schemas/SchemaCardsBillingDetails"},"refund_reason":{"type":"string","description":"Text description of the refund reason.","example":"Solidgate - Issuer Fraud Notification"},"refund_reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code representing the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/refund-reasons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reason"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This code is used to identify the reason for both "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" transactions "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"operation"},"children":[]}]}]}]}],"minLength":4,"maxLength":4,"example":"0022"},"card_token":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsCardToken"},{"type":"object","properties":{"original_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method used to capture the card credentials at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}],"enum":["card","apple-pay","google-pay","network-token","click-to-pay"],"example":"card"}}}]},"card":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsCard"},{"type":"object","properties":{"card_token":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsCardToken"},{"type":"object","properties":{"original_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method used to capture the card credentials at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}],"enum":["card","apple-pay","google-pay","network-token","click-to-pay"],"example":"card"}}}]}}}]},"error":{"$ref":"#/components/schemas/SchemaCardsDiscriminatorErrorSuccess"},"payment_account_reference":{"type":"string","description":"Payment Account Reference (PAR) is a unique, non-financial identifier for a payment account that remains consistent across card replacements.","example":"PAR_1A2B3C4D5E6F7G8H9"},"arn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acquirer Reference Number (ARN) assigned to transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use ARN to check transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"example":"12345678901234567890123"},"rrn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieval Reference Number (RRN) assigned to transactions, based on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8583","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8583"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standard."},"children":[]}]}]}],"minLength":12,"maxLength":12,"example":"100034876543"}}},"transactions":{"type":"object","description":"Map of transactions where the keys are transaction identifiers.","properties":{"<transaction_id_value_#1>":{"type":"object","description":"Details of a card transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.","required":["amount","card","created_at","currency","id","operation","status","updated_at"],"properties":{"id":{"type":"string","description":"Unique transaction identifier.","example":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2026-07-15 11:45:30"},"updated_at":{"type":"string","description":"Datetime when the transaction was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2026-07-16 11:45:30"},"amount":{"type":"integer","description":"Transaction amount.","example":100},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the transaction."},"children":[]}]}]}],"maxLength":3,"minLength":3,"example":"USD"},"marketing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It should not be considered financial information, but it can be used for forecasting."},"children":[]}]}]}]},"marketing_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the currency used for calculation of marketing amount."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["recurring-auth","refund","resign-auth","auth","settle","void","apple-pay","google-pay"],"example":"auth"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In the case of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"fail"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"error"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object will be returned at the transactions level in the response."},"children":[]}]}]}],"enum":["processing","success","fail","verify"],"example":"success"},"authorization_type":{"type":"string","enum":["final","estimated","incremental"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"scheme_transaction_id":{"type":"string","description":"Card-scheme transaction identifier linking this transaction to the original customer-initiated payment."},"transaction_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Link Identifier ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is an ID generated by Mastercard to link lifecycle activity after the original transaction."},"children":[]}]}]}],"maxLength":255},"descriptor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying text that appears on a customer’s credit or debit card statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It includes information about the transaction and helps the cardholder recognize the charge."},"children":[]}]}]}],"example":"google.com"},"billing_details":{"$ref":"#/components/schemas/SchemaCardsBillingDetails"},"refund_reason":{"type":"string","description":"Text description of the refund reason.","example":"Solidgate - Issuer Fraud Notification"},"refund_reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code representing the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/refund-reasons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reason"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This code is used to identify the reason for both "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" transactions "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"operation"},"children":[]}]}]}]}],"minLength":4,"maxLength":4,"example":"0022"},"card_token":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsCardToken"},{"type":"object","properties":{"original_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method used to capture the card credentials at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}],"enum":["card","apple-pay","google-pay","network-token","click-to-pay"],"example":"card"}}}]},"card":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsCard"},{"type":"object","properties":{"card_token":{"allOf":[{"$ref":"#/components/schemas/SchemaCardsCardToken"},{"type":"object","properties":{"original_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method used to capture the card credentials at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}],"enum":["card","apple-pay","google-pay","network-token","click-to-pay"],"example":"card"}}}]}}}]},"error":{"$ref":"#/components/schemas/SchemaCardsDiscriminatorErrorSuccess"},"payment_account_reference":{"type":"string","description":"Payment Account Reference (PAR) is a unique, non-financial identifier for a payment account that remains consistent across card replacements.","example":"PAR_1A2B3C4D5E6F7G8H9"},"arn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acquirer Reference Number (ARN) assigned to transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use ARN to check transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"example":"12345678901234567890123"},"rrn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieval Reference Number (RRN) assigned to transactions, based on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8583","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8583"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standard."},"children":[]}]}]}],"minLength":12,"maxLength":12,"example":"100034876543"}}}},"required":["<transaction_id_value_#1>"]},"three_ds":{"$ref":"#/components/schemas/SchemaCardsThreeDs"},"routing":{"$ref":"#/components/schemas/SchemaCardsRouting"},"antifraud_result":{"$ref":"#/components/schemas/SchemaCardsAntifraudResult"},"verification_result":{"$ref":"#/components/schemas/SchemaCardsVerificationResult"},"chargebacks":{"type":"object","description":"Map of chargebacks where the keys are chargeback identifiers.","properties":{"<chargeback_id_value_#1>":{"$ref":"#/components/schemas/SchemaCardsChargeback"}}},"device_info":{"$ref":"#/components/schemas/SchemaCardsDeviceInfo"},"verify_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the customer should be redirected to complete 3DS authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Only after opening the URL and authenticating the order "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" change to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"redirect_url":{"type":"string","description":"URL where customer should be redirected after finishing 3D Secure or redirect payment method."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"pay_form":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPayForm"}]},"payment_adviser":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPaymentAdviser"}]}},"required":["order","transactions"]}},"components/schemas/SchemaCardsDiscriminatorError":{"id":"components/schemas/SchemaCardsDiscriminatorError","kind":"json-schema","title":"SchemaCardsDiscriminatorError","data":{"description":"Error object.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the declined payment."},"children":[]}]}]}]}},"discriminator":{"propertyName":"code","mapping":{"2.01 Order not found":"#/components/schemas/SchemaMainErrorOrderNotFound","X.XX":"#/components/schemas/SchemaCardsError"}}}},"components/schemas/ResponseCardsError":{"id":"components/schemas/ResponseCardsError","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"error":{"$ref":"#/components/schemas/SchemaCardsDiscriminatorError"}},"required":["error"]}},"components/schemas/RequestCardsArn":{"id":"components/schemas/RequestCardsArn","kind":"json-schema","title":"RequestCardsArn","data":{"title":"RequestCardsArn","type":"object","properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255,"example":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55"}},"required":["order_id"]}},"components/schemas/SchemaCardsArnCode":{"id":"components/schemas/SchemaCardsArnCode","kind":"json-schema","title":"CardArnCodeModel","data":{"title":"CardArnCodeModel","type":"object","properties":{"arn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acquirer Reference Number (ARN) assigned to transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use ARN to check transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"example":"12345678901234567890123"},"created_at":{"type":"string","description":"Datetime when the refund was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2026-07-15 11:45:30"},"amount_refunded":{"type":"integer","description":"Refund amount.","example":100},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"transaction_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["processing","success","fail","verify"],"example":"success"},"sp_transaction_id":{"type":"string","description":"Unique transaction identifier.","deprecated":true,"maxLength":100,"example":"9ec44dfd75936f248a5d68dd7045bbbd63ab10ad9246f"}},"required":["amount_refunded","arn_code","created_at","currency","transaction_status"]}},"components/schemas/ResponseCardsArn":{"id":"components/schemas/ResponseCardsArn","kind":"json-schema","title":"Success","data":{"title":"Success","properties":{"arn_codes":{"type":"array","description":"Array data with information about ARN codes corresponding to the order requested.","items":{"$ref":"#/components/schemas/SchemaCardsArnCode"}}}}},"components/schemas/SchemaApmCardShippingAddress":{"id":"components/schemas/SchemaApmCardShippingAddress","kind":"json-schema","title":"SchemaApmCardShippingAddress","data":{"title":"SchemaApmCardShippingAddress","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address to ship."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If this field is passed by the merchant - the customer cannot change this address."},"children":[]}]}]}],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the shipping address."},"children":[]}]}]}],"format":"iso_code_a3","minLength":3,"maxLength":3},"state":{"type":"string","description":"Code of the state where the person, business or institution is located.","maxLength":100},"city":{"type":"string","description":"City or town where the person, business or institution is located.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code where the person, business or institution is located.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}}},"components/schemas/RequestApmInitPaymentPaypal":{"id":"components/schemas/RequestApmInitPaymentPaypal","kind":"json-schema","title":"RequestApmInitPaymentPaypal","data":{"title":"RequestApmInitPaymentPaypal","type":"object","required":["amount","currency","order_id","order_description","customer_email","ip_address","platform","payment_method"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["paypal-vault"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For COP, CRC, HUF, LAK, RSD, and TWD, should pass the integer value of the amount with two zeros at the end (for example, XXXX00, which will be transferred as XXXX.00). The value 0 is valid only for obtaining a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/#billing-agreement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"billing agreement token"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (recurring-token)."},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the init-payment subscription and one-time payments, the field value is displayed on the user's PayPal statement."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription payments, this field is configured in the product settings as Public description when "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#edit-product","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"editing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" a product via Hub."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"}]},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentAlipay":{"id":"components/schemas/RequestApmInitPaymentAlipay","kind":"json-schema","title":"RequestApmInitPaymentAlipay","data":{"title":"RequestApmInitPaymentAlipay","type":"object","required":["amount","currency","order_id","order_description","customer_email","ip_address","platform","payment_method","billing_address","future_usage"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["alipay"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For CNY currency, the amount should be in cents (e.g., 8900 = 89.00 CNY)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"default":"CNY"},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"one-time"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for single payments or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for recurring payments."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The field value is displayed in the customer's Alipay transaction history."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client platform used to select the appropriate customer confirmation path during checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP opens authorization in an app context, MOB continues in mobile web, WEB runs a desktop browser flow."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/SchemaApmFutureUsageBlikDirect":{"id":"components/schemas/SchemaApmFutureUsageBlikDirect","kind":"json-schema","title":"direct","data":{"title":"direct","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"direct"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of payment for future usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"direct"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik/blik-recurring/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Blik Recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["one-time","unscheduled"]}}}},"components/schemas/SchemaApmFutureUsageBlikRedirect":{"id":"components/schemas/SchemaApmFutureUsageBlikRedirect","kind":"json-schema","title":"redirect","data":{"title":"redirect","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"redirect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}}},"components/schemas/SchemaApmCardBillingAddress":{"id":"components/schemas/SchemaApmCardBillingAddress","kind":"json-schema","title":"SchemaApmCardBillingAddress","data":{"title":"SchemaApmCardBillingAddress","type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"format":"iso_code_a3","minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}}},"components/schemas/SchemaApmPaymentTypeDataBlikCode":{"id":"components/schemas/SchemaApmPaymentTypeDataBlikCode","kind":"json-schema","title":"direct","data":{"title":"direct","type":"object","properties":{"blik_code":{"type":"string","description":"BLIK code, obtained from the Blik app, for transaction processing.","minLength":6,"maxLength":6,"pattern":"^\\d{6}$"}},"required":["blik_code"]}},"components/schemas/RequestApmInitPaymentBlik":{"id":"components/schemas/RequestApmInitPaymentBlik","kind":"json-schema","title":"RequestApmInitPaymentBlik","data":{"title":"RequestApmInitPaymentBlik","type":"object","required":["order_id","amount","currency","order_description","customer_email","ip_address","platform","payment_method","billing_address","future_usage","payment_method_flow"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["blik"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"payment_method_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" according to this method."},"children":[]}]}]}],"enum":["direct","redirect"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmFutureUsageBlikDirect"},{"$ref":"#/components/schemas/SchemaApmFutureUsageBlikRedirect"}]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":"User-agent string of the device used by the customer.","minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataBlikCode"}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/SchemaApmFutureUsageBlikBnplRedirect":{"id":"components/schemas/SchemaApmFutureUsageBlikBnplRedirect","kind":"json-schema","title":"redirect","data":{"title":"redirect","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"redirect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}}},"components/schemas/RequestApmInitPaymentBlikBnpl":{"id":"components/schemas/RequestApmInitPaymentBlikBnpl","kind":"json-schema","title":"RequestApmInitPaymentBlikBnpl","data":{"title":"RequestApmInitPaymentBlikBnpl","type":"object","required":["order_id","amount","currency","order_description","customer_email","ip_address","platform","payment_method","billing_address","future_usage","payment_method_flow"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik/blik-pay-later/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["blik-bnpl"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"payment_method_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" according to this method."},"children":[]}]}]}],"enum":["redirect"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmFutureUsageBlikBnplRedirect"}]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":"User-agent string of the device used by the customer.","minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentBizum":{"id":"components/schemas/RequestApmInitPaymentBizum","kind":"json-schema","title":"RequestApmInitPaymentBizum","data":{"title":"RequestApmInitPaymentBizum","type":"object","required":["amount","currency","order_id","order_description","customer_email","customer_phone","ip_address","platform","payment_method","billing_address","future_usage"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/bizum","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["bizum"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For EUR currency, the amount should be in cents (e.g., 400 = 4.00 EUR)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"enum":["EUR"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The field value is displayed in the customer's Bizum transaction history."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"minLength":5,"maxLength":15},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentBoleto":{"id":"components/schemas/RequestApmInitPaymentBoleto","kind":"json-schema","title":"RequestApmInitPaymentBoleto","data":{"title":"RequestApmInitPaymentBoleto","type":"object","required":["order_id","amount","currency","order_description","customer_email","ip_address","platform","payment_method","payment_type_data","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["boleto"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_method_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" according to this method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the field is not specified, the process available in the method is used."},"children":[]}]}]}],"enum":["redirect","direct"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"brazil_cpf":{"type":"string","description":"Individual taxpayer registry identification number should be collected and provided for Brazilian customers.","maxLength":11}},"required":["brazil_cpf"]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentCashapp":{"id":"components/schemas/RequestApmInitPaymentCashapp","kind":"json-schema","title":"RequestApmInitPaymentCashapp","data":{"title":"RequestApmInitPaymentCashapp","type":"object","required":["amount","currency","order_id","order_description","customer_email","ip_address","platform","payment_method","billing_address","future_usage"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/cash-app-pay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["cashapp"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For USD currency, the amount should be in cents (e.g., 1020 = 10.20 USD)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"enum":["USD"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"minLength":5,"maxLength":15},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentEfecty":{"id":"components/schemas/RequestApmInitPaymentEfecty","kind":"json-schema","title":"RequestApmInitPaymentEfecty","data":{"title":"RequestApmInitPaymentEfecty","type":"object","required":["order_id","amount","currency","order_description","customer_email","ip_address","platform","payment_method","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/efecty","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["efecty"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["COP"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":"Public IP address of the cardholder.","maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":"Additional data required for the specific payment method.","properties":{"colombia_cc":{"type":"string","description":"Colombian citizen identifier number.","maxLength":10}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentGcash":{"id":"components/schemas/RequestApmInitPaymentGcash","kind":"json-schema","title":"RequestApmInitPaymentGcash","data":{"title":"RequestApmInitPaymentGcash","type":"object","required":["amount","currency","order_id","order_description","customer_email","customer_first_name","customer_last_name","ip_address","platform","payment_method","billing_address","future_usage","return_url"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["gcash"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For PHP currency, the amount should be in cents (e.g., 2575 = 25.75 PHP)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"enum":["PHP"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"one-time"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for single payments or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for recurring payments."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The field value is displayed in the customer's GCash transaction history."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentIdeal":{"id":"components/schemas/RequestApmInitPaymentIdeal","kind":"json-schema","title":"RequestApmInitPaymentIdeal","data":{"title":"RequestApmInitPaymentIdeal","type":"object","required":["order_id","amount","currency","order_description","customer_email","ip_address","platform","payment_method","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/ideal","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["ideal"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"To prevent errors, most iDEAL systems reject descriptions containing characters that could cause issues, such as HTML editing codes, which might lead to problems."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":35},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":19,"pattern":"^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}:\\d{2})?$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/SchemaApmFutureUsageKlarnaOneTime":{"id":"components/schemas/SchemaApmFutureUsageKlarnaOneTime","kind":"json-schema","title":"one-time","data":{"title":"one-time","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials for one-time Klarna payments."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}}},"components/schemas/SchemaApmFutureUsageBillingPeriodKlarna":{"id":"components/schemas/SchemaApmFutureUsageBillingPeriodKlarna","kind":"json-schema","title":"billing_period","data":{"title":"billing_period","type":"object","description":"Billing frequency for Klarna recurring payments.","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Billing period unit.","enum":["day","week","month","year"]},"value":{"type":"integer","description":"Number of units between recurring charges.","exclusiveMinimum":true,"minimum":0}}}},"components/schemas/SchemaApmFutureUsageKlarnaRecurring":{"id":"components/schemas/SchemaApmFutureUsageKlarnaRecurring","kind":"json-schema","title":"recurring","data":{"title":"recurring","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring Klarna authorization for subsequent subscription charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" together with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"billing_amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"billing_period"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_price_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used."},"children":[]}]}]}],"required":["payment_type","billing_amount","billing_period"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["recurring"]},"billing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" charged in each subsequent recurring payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Must match the billing plan the customer agrees to at mandate creation. It is separate from the initial charge "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and can differ."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"billing_period":{"$ref":"#/components/schemas/SchemaApmFutureUsageBillingPeriodKlarna"}}}},"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOriginators":{"id":"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOriginators","kind":"json-schema","title":"Originators","data":{"title":"Originators","type":"array","description":"Array of third-party systems that are responsible for the request (e.g. Shopify, WooCommerce). If the request is sent through multiple systems before reaching the Solidgate, each system can be represented as an originator.","maxItems":10,"items":{"type":"object","required":["name","session_reference"],"properties":{"name":{"type":"string","description":"The name of the originator.","pattern":"^[A-Z0-9_]+$","maxLength":50,"example":"SHOPIFY"},"session_reference":{"type":"string","description":"A reference to the session that is being used.","minLength":1,"maxLength":100},"module_name":{"type":"string","description":"The name of the module that is being used.","minLength":1,"maxLength":50},"module_version":{"type":"string","description":"The version of the module that is being used.","minLength":1,"maxLength":50}}}}},"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOtherCountries":{"id":"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOtherCountries","kind":"json-schema","title":"Other countries","data":{"title":"Other countries","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Klarna boost features and session continuity fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use without a country document when the customer market does not require a national identity field, or when only boost features data is available."},"children":[]}]}]}],"properties":{"klarna_network_session_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Klarna Web SDK session token."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for Klarna boost features like Express Checkout, On-Site Messaging, and Sign in with Klarna. Enables session continuity and pre-filled customer details."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Obtain the token from the Klarna Web SDK and always use the latest value. Never reuse a consumed token."},"children":[]}]}]}],"maxLength":10240},"klarna_network_data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Klarna Network Data (KND). Structured JSON pass-through carrying Klarna payment context across the payment lifecycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to include supplementary purchase data, for example order line items, as described in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.klarna.com/acquirer/solidgate/get-started/optimize-klarna-transactions/how-to-share-klarna-network-data/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"How to send Klarna Network Data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":10240},"klarna_originators":{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOriginators"}}}},"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkSwe":{"id":"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkSwe","kind":"json-schema","title":"Sweden","data":{"title":"Sweden","allOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOtherCountries"},{"type":"object","properties":{"sweden_pin":{"type":"string","description":"Swedish personal identity number for customers in Sweden.","pattern":"^[0-9]{8}-[0-9]{4}$","maxLength":13,"example":"19811228-9874"}}}]}},"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkNor":{"id":"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkNor","kind":"json-schema","title":"Norway","data":{"title":"Norway","allOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOtherCountries"},{"type":"object","properties":{"norway_nin":{"type":"string","description":"Norwegian national identity number for customers in Norway.","pattern":"^[0-9]{11}$","maxLength":11,"example":"01017012345"}}}]}},"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkIta":{"id":"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkIta","kind":"json-schema","title":"Italy","data":{"title":"Italy","allOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOtherCountries"},{"type":"object","properties":{"italy_cf":{"type":"string","description":"Italian tax code, codice fiscale, for customers in Italy.","pattern":"^[A-Z]{6}[0-9]{2}[ABCDEHLMPRST][0-9]{2}[A-Z][0-9]{3}[A-Z]$","maxLength":16,"example":"RSSMRA85M01H501Z"}}}]}},"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkFin":{"id":"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkFin","kind":"json-schema","title":"Finland","data":{"title":"Finland","allOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOtherCountries"},{"type":"object","properties":{"finland_hetu":{"type":"string","description":"Finnish personal identity code for customers in Finland.","pattern":"^[0-9]{6}[A+-][0-9]{3}[0-9A-Z]$","maxLength":11,"example":"131052-308T"}}}]}},"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkEsp":{"id":"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkEsp","kind":"json-schema","title":"Spain","data":{"title":"Spain","allOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOtherCountries"},{"type":"object","properties":{"spain_dni":{"type":"string","description":"Spanish national ID, DNI, for customers in Spain.","pattern":"^[0-9]{8}[A-Z]$","maxLength":9,"example":"12345678Z"}}}]}},"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkDnk":{"id":"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkDnk","kind":"json-schema","title":"Denmark","data":{"title":"Denmark","allOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOtherCountries"},{"type":"object","properties":{"denmark_cpr":{"type":"string","description":"Danish civil registration number for customers in Denmark.","pattern":"^[0-9]{6}-[0-9]{4}$","maxLength":11,"example":"120578-1234"}}}]}},"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkUsa":{"id":"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkUsa","kind":"json-schema","title":"United States","data":{"title":"United States","allOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOtherCountries"},{"type":"object","properties":{"usa_ssn":{"type":"string","description":"US Social Security Number for customers in the United States.","pattern":"^([0-9]{3}-[0-9]{2}-[0-9]{4}|[0-9]{9})$","maxLength":11,"example":"123-45-6789"}}}]}},"components/schemas/RequestApmInitPaymentKlarnaNetwork":{"id":"components/schemas/RequestApmInitPaymentKlarnaNetwork","kind":"json-schema","title":"RequestApmInitPaymentKlarnaNetwork","data":{"title":"RequestApmInitPaymentKlarnaNetwork","type":"object","required":["order_id","amount","currency","order_description","customer_email","ip_address","platform","payment_method","billing_address","future_usage","item_category"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/klarna/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["klarna-network"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use the local currency for the selected purchase country."},"children":[]}]}]}],"enum":["AUD","CAD","CHF","CZK","DKK","EUR","GBP","HUF","MXN","NOK","NZD","PLN","RON","SEK","USD"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmFutureUsageKlarnaOneTime"},{"$ref":"#/components/schemas/SchemaApmFutureUsageKlarnaRecurring"}]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order description displayed to the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide a clear description of the subscribed product for recurring payments. It is displayed in the Klarna Customer Journey and affects the customer experience."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","minLength":6,"maxLength":100},"customer_first_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's first name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":99},"customer_last_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's last name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":99},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":"Product category sent to Klarna for eligibility and address handling.","enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"format":"iso_code_a3","minLength":3,"maxLength":3},"state":{"type":"string","description":"Billing state or region.","maxLength":99},"city":{"type":"string","description":"City name.","maxLength":99},"zip":{"type":"string","description":"Address zip or postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":99},"line2":{"type":"string","description":"Second line of the address.","maxLength":99}}},"shipping_address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping address details."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the shipping address."},"children":[]}]}]}],"format":"iso_code_a3","minLength":3,"maxLength":3},"state":{"type":"string","description":"Shipping state or region.","maxLength":99},"city":{"type":"string","description":"City name.","maxLength":99},"zip":{"type":"string","description":"Address zip or postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":99},"line2":{"type":"string","description":"Second line of the address.","maxLength":99}}},"payment_type_data":{"type":"object","description":"Additional data required to make payments with Klarna.","oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkSwe"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkNor"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkIta"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkFin"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkEsp"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkDnk"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkUsa"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOtherCountries"}]},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs in ranges 10.0.0.0 to 10.255.255.255, 172.16.0.0 to 172.31.255.255, and 192.168.0.0 to 192.168.255.255 will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":"User agent string of the device used by the customer.","minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentMbway":{"id":"components/schemas/RequestApmInitPaymentMbway","kind":"json-schema","title":"RequestApmInitPaymentMbway","data":{"title":"RequestApmInitPaymentMbway","type":"object","required":["order_id","amount","currency","order_description","customer_email","customer_phone","ip_address","platform","payment_method","billing_address","future_usage"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mb-way","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mbway"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of payment for future usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"one-time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - no token created, for one-off use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1-click"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - token for future CIT without re-entering details"},"children":[]}]}]}]}],"enum":["one-time","1-click"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"}]},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/SchemaApmPaymentTypeDataMercadopagoArg":{"id":"components/schemas/SchemaApmPaymentTypeDataMercadopagoArg","kind":"json-schema","title":"Argentina","data":{"title":"Argentina","properties":{"argentina_dni":{"type":"string","description":"National identity document code should be collected and provided for Argentinian cardholders.","maxLength":9}},"required":["argentina_dni"]}},"components/schemas/SchemaApmPaymentTypeDataMercadopagoBra":{"id":"components/schemas/SchemaApmPaymentTypeDataMercadopagoBra","kind":"json-schema","title":"Brazil","data":{"title":"Brazil","properties":{"brazil_cpf":{"type":"string","description":"Individual taxpayer registry identification number should be collected and provided for Brazilian customers.","maxLength":11}},"required":["brazil_cpf"]}},"components/schemas/SchemaApmPaymentTypeDataMercadopagoChl":{"id":"components/schemas/SchemaApmPaymentTypeDataMercadopagoChl","kind":"json-schema","title":"Chile","data":{"title":"Chile","properties":{"chile_ci":{"type":"string","description":"Chilean citizen identifier number.","maxLength":9}},"required":["chile_ci"]}},"components/schemas/SchemaApmPaymentTypeDataMercadopagoCol":{"id":"components/schemas/SchemaApmPaymentTypeDataMercadopagoCol","kind":"json-schema","title":"Colombia","data":{"title":"Colombia","properties":{"colombia_cc":{"type":"string","description":"Colombian citizen identifier number.","maxLength":10}},"required":["colombia_cc"]}},"components/schemas/SchemaApmPaymentTypeDataMercadopagoMex":{"id":"components/schemas/SchemaApmPaymentTypeDataMercadopagoMex","kind":"json-schema","title":"Mexico","data":{"title":"Mexico","properties":{"mexico_curp":{"type":"string","description":"Unique Population Registry Code.","minLength":18,"maxLength":18}},"required":["mexico_curp"]}},"components/schemas/SchemaApmPaymentTypeDataMercadopagoPer":{"id":"components/schemas/SchemaApmPaymentTypeDataMercadopagoPer","kind":"json-schema","title":"Peru","data":{"title":"Peru","properties":{"peru_dni":{"type":"string","description":"National identity document code for Peruvian cardholders.","maxLength":9}},"required":["peru_dni"]}},"components/schemas/SchemaApmPaymentTypeDataMercadopagoUry":{"id":"components/schemas/SchemaApmPaymentTypeDataMercadopagoUry","kind":"json-schema","title":"Uruguay","data":{"title":"Uruguay","properties":{"uruguay_ci":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cédula de Identidad (National Identity Card) for Uruguay."},"children":[]}]}]}],"maxLength":8}},"required":["uruguay_ci"]}},"components/schemas/RequestApmInitPaymentMercadopago":{"id":"components/schemas/RequestApmInitPaymentMercadopago","kind":"json-schema","title":"RequestApmInitPaymentMercadopago","data":{"title":"RequestApmInitPaymentMercadopago","type":"object","required":["order_id","amount","currency","order_description","customer_email","customer_first_name","customer_last_name","ip_address","platform","payment_method","payment_type_data","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mercado-pago","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mercadopago"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil or VAT/PAIS in Argentina."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["ARS","BRL","CLP","COP","MXN","PEN","UYU"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"}]},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific payment methods. Specify the value that belongs to the user country."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ARG - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"argentina_dni"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", BRA - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"brazil_cpf"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", CHL - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"chile_ci"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", COL - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"colombia_cc"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", MEX - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"mexico_curp"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", PER - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"peru_dni"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", URY - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"uruguay_ci"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoArg"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoBra"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoChl"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoCol"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoMex"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoPer"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoUry"}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentMobilepay":{"id":"components/schemas/RequestApmInitPaymentMobilepay","kind":"json-schema","title":"RequestApmInitPaymentMobilepay","data":{"title":"RequestApmInitPaymentMobilepay","type":"object","required":["order_id","amount","currency","order_description","customer_email","customer_first_name","customer_last_name","ip_address","platform","payment_method","billing_address","future_usage"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mobilepay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mobilepay"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["DKK"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":"User-agent string of the device used by the customer.","minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentMultibanco":{"id":"components/schemas/RequestApmInitPaymentMultibanco","kind":"json-schema","title":"RequestApmInitPaymentMultibanco","data":{"title":"RequestApmInitPaymentMultibanco","type":"object","required":["amount","currency","order_id","order_description","customer_email","ip_address","platform","payment_method","billing_address","future_usage"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/multibanco","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["multibanco"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For EUR currency, the amount should be in cents (e.g., 2490 = 24.90 EUR)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"enum":["EUR"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"minLength":5,"maxLength":15},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmInitPaymentOpenbanking":{"id":"components/schemas/RequestApmInitPaymentOpenbanking","kind":"json-schema","title":"RequestApmInitPaymentOpenbanking","data":{"title":"RequestApmInitPaymentOpenbanking","type":"object","required":["amount","currency","order_id","order_description","item_category","customer_email","ip_address","platform","payment_method","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pay-by-bank/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["openbanking"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR","GBP"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":"Type of goods.","enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentOxxo":{"id":"components/schemas/RequestApmInitPaymentOxxo","kind":"json-schema","title":"RequestApmInitPaymentOxxo","data":{"title":"RequestApmInitPaymentOxxo","type":"object","required":["order_id","amount","currency","order_description","customer_email","ip_address","platform","payment_method","payment_type_data","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/oxxo","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["oxxo"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["MXN"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"mexico_curp":{"type":"string","description":"Unique Population Registry Code.","minLength":18,"maxLength":18}},"required":["mexico_curp"]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmInitPaymentPix":{"id":"components/schemas/RequestApmInitPaymentPix","kind":"json-schema","title":"RequestApmInitPaymentSmartPix","data":{"title":"RequestApmInitPaymentSmartPix","type":"object","required":["order_id","amount","currency","order_description","customer_email","customer_first_name","customer_last_name","ip_address","platform","payment_method","payment_type_data","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix payments via redirect to the customer’s bank page."},"children":[]}]}]}],"enum":["pix"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the category of the item."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"physical_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - tangible item that can be shipped with proof of delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"digital_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - goods that are stored, delivered, and used in electronic format"},"children":[]}]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"enum":["BRA"]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by customer at the moment of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"brazil_cpf":{"type":"string","description":"Individual taxpayer registry identification number should be collected and provided for Brazilian customers.","maxLength":11}},"required":["brazil_cpf"]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentPixQr":{"id":"components/schemas/RequestApmInitPaymentPixQr","kind":"json-schema","title":"RequestApmInitPaymentPixQr","data":{"title":"RequestApmInitPaymentPixQr","type":"object","required":["order_id","amount","currency","order_description","customer_email","customer_first_name","customer_last_name","ip_address","platform","payment_method","payment_type_data","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix payments via redirect to a page with QR."},"children":[]}]}]}],"enum":["pix-qr"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the category of the item."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"physical_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - tangible item that can be shipped with proof of delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"digital_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - goods that are stored, delivered, and used in electronic format"},"children":[]}]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"enum":["BRA"]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform, which the customer used at the moment of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data that is required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"brazil_cpf":{"type":"string","description":"Individual taxpayer registry identification number should be collected and provided for Brazilian customers.","maxLength":11}},"required":["brazil_cpf"]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/SchemaApmFutureUsageBillingPeriodPixAutomatico":{"id":"components/schemas/SchemaApmFutureUsageBillingPeriodPixAutomatico","kind":"json-schema","title":"Pix Automático billing period","data":{"title":"Pix Automático billing period","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring billing interval for the mandate."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Only the following "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"value"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" pairs are accepted."},"children":[]}]}]}],"oneOf":[{"title":"Weekly (7 days)","type":"object","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Billing interval unit.","enum":["day"]},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"day"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a weekly interval."},"children":[]}]}]}],"enum":[7]}},"additionalProperties":false},{"title":"Weekly (1 week)","type":"object","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Billing interval unit.","enum":["week"]},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"week"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a weekly interval."},"children":[]}]}]}],"enum":[1]}},"additionalProperties":false},{"title":"Monthly","type":"object","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Billing interval unit.","enum":["month"]},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"month"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a monthly interval."},"children":[]}]}]}],"enum":[1]}},"additionalProperties":false},{"title":"Quarterly","type":"object","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Billing interval unit.","enum":["month"]},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"month"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a quarterly interval."},"children":[]}]}]}],"enum":[3]}},"additionalProperties":false},{"title":"Semi-annually","type":"object","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Billing interval unit.","enum":["month"]},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"month"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a semi-annual interval."},"children":[]}]}]}],"enum":[6]}},"additionalProperties":false},{"title":"Annually (12 months)","type":"object","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Billing interval unit.","enum":["month"]},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"month"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an annual interval."},"children":[]}]}]}],"enum":[12]}},"additionalProperties":false},{"title":"Annually (1 year)","type":"object","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Billing interval unit.","enum":["year"]},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"year"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an annual interval."},"children":[]}]}]}],"enum":[1]}},"additionalProperties":false}]}},"components/schemas/SchemaApmFutureUsagePixAutomatico":{"id":"components/schemas/SchemaApmFutureUsagePixAutomatico","kind":"json-schema","title":"Future usage for Pix Automático","data":{"title":"Future usage for Pix Automático","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines recurring "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mandate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters."},"children":[]}]}]}],"required":["payment_type","billing_period","max_amount"],"properties":{"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pix Automático mandate authorization."},"children":[]}]}]}],"enum":["recurring"]},"billing_period":{"$ref":"#/components/schemas/SchemaApmFutureUsageBillingPeriodPixAutomatico"},"max_amount":{"type":"integer","description":"Maximum authorized charge amount per billing cycle in the smallest currency unit for BRL.","exclusiveMinimum":true,"minimum":0}}}},"components/schemas/RequestApmInitPaymentPixAutomatico":{"id":"components/schemas/RequestApmInitPaymentPixAutomatico","kind":"json-schema","title":"RequestApmInitPaymentPixAutomatico","data":{"title":"RequestApmInitPaymentPixAutomatico","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initial charge for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pix Automático"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the billing plan is not taken from a Solidgate product."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to define the mandate interval and authorization ceiling. For catalog based flows, use the product based init payment schema instead."},"children":[]}]}]}],"required":["order_id","amount","currency","order_description","customer_email","customer_first_name","customer_last_name","ip_address","platform","payment_method","payment_type_data","billing_address","future_usage"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["pix-automatico"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"future_usage":{"$ref":"#/components/schemas/SchemaApmFutureUsagePixAutomatico"},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the category of the item."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"physical_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - tangible item that can be shipped with proof of delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"digital_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - goods that are stored, delivered, and used in electronic format"},"children":[]}]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"enum":["BRA"]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by customer at the moment of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"brazil_cpf":{"type":"string","description":"Individual taxpayer registry identification number should be collected and provided for Brazilian customers.","maxLength":11}},"required":["brazil_cpf"]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentPrzelewy24":{"id":"components/schemas/RequestApmInitPaymentPrzelewy24","kind":"json-schema","title":"RequestApmInitPaymentPrzelewy24","data":{"title":"RequestApmInitPaymentPrzelewy24","type":"object","required":["order_id","amount","currency","order_description","customer_email","customer_first_name","customer_last_name","ip_address","platform","payment_method","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/przelewy24","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["przelewy24"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentPse":{"id":"components/schemas/RequestApmInitPaymentPse","kind":"json-schema","title":"RequestApmInitPaymentPSE","data":{"title":"RequestApmInitPaymentPSE","type":"object","required":["order_id","amount","currency","order_description","customer_email","ip_address","platform","payment_method","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pse","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["pse"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["COP"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":"Public IP address of the cardholder.","maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":"Additional data required for the specific payment method.","properties":{"colombia_cc":{"type":"string","description":"Colombian citizen identifier number.","maxLength":10}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentSencillito":{"id":"components/schemas/RequestApmInitPaymentSencillito","kind":"json-schema","title":"RequestApmInitPaymentSencillito","data":{"title":"RequestApmInitPaymentSencillito","type":"object","required":["order_id","amount","currency","order_description","customer_email","ip_address","platform","payment_method","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/sencillito","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["sencillito"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["CLP"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":"Public IP address of the cardholder.","maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":"Additional data required for the specific payment method.","properties":{"chile_ci":{"type":"string","description":"Chilean citizen identifier number.","maxLength":9}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentServipag":{"id":"components/schemas/RequestApmInitPaymentServipag","kind":"json-schema","title":"RequestApmInitPaymentServipag","data":{"title":"RequestApmInitPaymentServipag","type":"object","required":["order_id","amount","currency","order_description","customer_email","ip_address","platform","payment_method","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/servipag","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["servipag"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["CLP"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":"Public IP address of the cardholder.","maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":"Additional data required for the specific payment method.","properties":{"chile_ci":{"type":"string","description":"Chilean citizen identifier number.","maxLength":9}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/SchemaApmFutureUsageUpiUnscheduled":{"id":"components/schemas/SchemaApmFutureUsageUpiUnscheduled","kind":"json-schema","title":"unscheduled","data":{"title":"unscheduled","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unscheduled mandate authorization for subsequent merchant-initiated charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_method_flow"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"direct"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for UPI Collect or with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"redirect"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for UPI Intent."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of payment for future usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for unscheduled or variable MIT charges."},"children":[]}]}]}],"enum":["unscheduled"]},"max_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum authorized charge amount per transaction in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for INR."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if no "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_price_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is provided. Otherwise, it sets a custom authorization ceiling."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0}}}},"components/schemas/SchemaApmFutureUsageUpiDirect":{"id":"components/schemas/SchemaApmFutureUsageUpiDirect","kind":"json-schema","title":"direct","data":{"title":"direct","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"direct"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Collect) flow."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmFutureUsageUpiUnscheduled"}]}},"components/schemas/SchemaApmFutureUsageBillingPeriodUpi":{"id":"components/schemas/SchemaApmFutureUsageBillingPeriodUpi","kind":"json-schema","title":"UPI billing period","data":{"title":"UPI billing period","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring billing interval for the UPI mandate."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage.payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and no "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_price_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is provided."},"children":[]}]}]}],"required":["unit","value"],"properties":{"unit":{"type":"string","description":"Billing interval unit.","enum":["day","week","month","year"]},"value":{"type":"integer","description":"Number of interval units between recurring charges.","minimum":1}}}},"components/schemas/SchemaApmFutureUsageUpiRecurring":{"id":"components/schemas/SchemaApmFutureUsageUpiRecurring","kind":"json-schema","title":"recurring","data":{"title":"recurring","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPI mandate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorization for subsequent charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_method_flow"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"redirect"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for UPI Intent."},"children":[]}]}]}],"required":["payment_type","max_amount","billing_period"],"properties":{"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of payment for future usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"UPI recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" mandates."},"children":[]}]}]}],"enum":["recurring"]},"max_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum authorized charge amount per billing cycle in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for INR."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"billing_period":{"$ref":"#/components/schemas/SchemaApmFutureUsageBillingPeriodUpi"}}}},"components/schemas/SchemaApmFutureUsageUpiRedirect":{"id":"components/schemas/SchemaApmFutureUsageUpiRedirect","kind":"json-schema","title":"redirect","data":{"title":"redirect","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"redirect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UPI Intent) flow."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmFutureUsageUpiRecurring"},{"$ref":"#/components/schemas/SchemaApmFutureUsageUpiUnscheduled"}]}},"components/schemas/SchemaApmBillingAddressUpi":{"id":"components/schemas/SchemaApmBillingAddressUpi","kind":"json-schema","title":"UPI billing address","data":{"title":"UPI billing address","allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing address details for UPI payments in India."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"country"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"zip"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" are required for UPI transactions."},"children":[]}]}]}],"properties":{"zip":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address zip/postal code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For addresses in India, the zip code must exactly be 6 characters long."},"children":[]}]}]}],"maxLength":10}},"required":["country","zip"]}},"components/schemas/SchemaApmPaymentTypeDataUpiVpa":{"id":"components/schemas/SchemaApmPaymentTypeDataUpiVpa","kind":"json-schema","title":"direct","data":{"title":"direct","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data for the UPI Collect ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"direct"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") flow."},"children":[]}]}]}],"properties":{"india_vpa":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Virtual Payment Address (VPA) used for UPI (Unified Payments Interface) transactions in India. VPA allows users to send and receive money electronically without requiring bank account details."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_method_flow"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"direct"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". For more information, refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"UPI payment method details"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":130,"pattern":"^.{1,100}@.{1,30}$"}},"required":["india_vpa"]}},"components/schemas/SchemaApmPaymentTypeDataUpiRedirect":{"id":"components/schemas/SchemaApmPaymentTypeDataUpiRedirect","kind":"json-schema","title":"redirect","data":{"title":"redirect","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not pass"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"redirect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UPI Intent). The customer authorizes the mandate through the deep link returned in the response."},"children":[]}]}]}]}},"components/schemas/RequestApmInitPaymentUpi":{"id":"components/schemas/RequestApmInitPaymentUpi","kind":"json-schema","title":"RequestApmInitPaymentUpi","data":{"title":"RequestApmInitPaymentUpi","type":"object","required":["order_id","amount","currency","order_description","customer_email","customer_first_name","customer_last_name","customer_phone","ip_address","platform","payment_method","billing_address","future_usage","payment_method_flow"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["upi"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["INR"]},"payment_method_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" according to this method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"direct"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for UPI Collect with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"india_vpa"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"redirect"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for UPI Intent; the customer authorizes via the deep link in the response."},"children":[]}]}]}],"enum":["direct","redirect"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmFutureUsageUpiDirect"},{"$ref":"#/components/schemas/SchemaApmFutureUsageUpiRedirect"}]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"$ref":"#/components/schemas/SchemaApmBillingAddressUpi"},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":"User-agent string of the device used by the customer.","minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataUpiVpa"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataUpiRedirect"}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentWebpay":{"id":"components/schemas/RequestApmInitPaymentWebpay","kind":"json-schema","title":"RequestApmInitPaymentWebpay","data":{"title":"RequestApmInitPaymentWebpay","type":"object","required":["order_id","amount","currency","order_description","customer_email","ip_address","platform","payment_method","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/webpay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["servipag"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["CLP"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":19,"pattern":"^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}:\\d{2})?$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":"Public IP address of the cardholder.","maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":"Additional data required for the specific payment method.","properties":{"chile_ci":{"type":"string","description":"Chilean citizen identifier number.","maxLength":9}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentWechatpay":{"id":"components/schemas/RequestApmInitPaymentWechatpay","kind":"json-schema","title":"RequestApmInitPaymentWechatpay","data":{"title":"RequestApmInitPaymentWechatpay","type":"object","required":["amount","currency","order_id","order_description","customer_email","ip_address","platform","payment_method","billing_address","future_usage"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["wechatpay"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For CNY currency, the amount should be in cents (e.g., 8900 = 89.00 CNY)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"default":"CNY"},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"one-time"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for single payments or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for recurring payments."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The field value is displayed in the customer's WeChat Pay transaction history."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client platform used to determine how the payer authorization journey is started."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP starts authorization in an app context, MOB follows a mobile browser path, WEB uses a desktop browser path."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitPaymentDiscriminator":{"id":"components/schemas/RequestApmInitPaymentDiscriminator","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","discriminator":{"propertyName":"payment_method","mapping":{"paypal-vault":"#/components/schemas/RequestApmInitPaymentPaypal","alipay":"#/components/schemas/RequestApmInitPaymentAlipay","blik":"#/components/schemas/RequestApmInitPaymentBlik","blik-bnpl":"#/components/schemas/RequestApmInitPaymentBlikBnpl","bizum":"#/components/schemas/RequestApmInitPaymentBizum","boleto":"#/components/schemas/RequestApmInitPaymentBoleto","cashapp":"#/components/schemas/RequestApmInitPaymentCashapp","efecty":"#/components/schemas/RequestApmInitPaymentEfecty","gcash":"#/components/schemas/RequestApmInitPaymentGcash","ideal":"#/components/schemas/RequestApmInitPaymentIdeal","klarna-network":"#/components/schemas/RequestApmInitPaymentKlarnaNetwork","mbway":"#/components/schemas/RequestApmInitPaymentMbway","mercadopago":"#/components/schemas/RequestApmInitPaymentMercadopago","mobilepay":"#/components/schemas/RequestApmInitPaymentMobilepay","multibanco":"#/components/schemas/RequestApmInitPaymentMultibanco","openbanking":"#/components/schemas/RequestApmInitPaymentOpenbanking","oxxo":"#/components/schemas/RequestApmInitPaymentOxxo","pix":"#/components/schemas/RequestApmInitPaymentPix","pix-qr":"#/components/schemas/RequestApmInitPaymentPixQr","pix-automatico":"#/components/schemas/RequestApmInitPaymentPixAutomatico","przelewy24":"#/components/schemas/RequestApmInitPaymentPrzelewy24","pse":"#/components/schemas/RequestApmInitPaymentPse","sencillito":"#/components/schemas/RequestApmInitPaymentSencillito","servipag":"#/components/schemas/RequestApmInitPaymentServipag","upi":"#/components/schemas/RequestApmInitPaymentUpi","webpay":"#/components/schemas/RequestApmInitPaymentWebpay","wechatpay":"#/components/schemas/RequestApmInitPaymentWechatpay"}}}},"components/schemas/RequestApmInitOneTimeProductPaypal":{"id":"components/schemas/RequestApmInitOneTimeProductPaypal","kind":"json-schema","title":"RequestApmInitOneTimeProductPaypal","data":{"title":"RequestApmInitOneTimeProductPaypal","type":"object","required":["order_id","customer_email","ip_address","platform","payment_method","product_id","customer_account_id","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["paypal-vault"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the init-payment subscription and one-time payments, the field value is displayed on the user's PayPal statement."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription payments, this field is configured in the product settings as Public description when "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#edit-product","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"editing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" a product via Hub."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security."},"children":[]}]}]}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductAlipay":{"id":"components/schemas/RequestApmInitOneTimeProductAlipay","kind":"json-schema","title":"RequestApmInitOneTimeProductAlipay","data":{"title":"RequestApmInitOneTimeProductAlipay","type":"object","required":["order_id","product_id","order_description","customer_account_id","customer_email","customer_phone","ip_address","platform","payment_method","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["alipay"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"default":"CNY"},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"one-time"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for single payments or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for recurring payments."},"children":[]}]}]}],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The field value is displayed in the customer's Alipay transaction history."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client platform used to select the appropriate customer confirmation path during checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP opens authorization in an app context, MOB continues in mobile web, WEB runs a desktop browser flow."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/SchemaApmFutureUsageBlikOneTimeProduct":{"id":"components/schemas/SchemaApmFutureUsageBlikOneTimeProduct","kind":"json-schema","title":"Future usage for Blik one-time product payment","data":{"title":"Future usage for Blik one-time product payment","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}}},"components/schemas/RequestApmInitOneTimeProductBlik":{"id":"components/schemas/RequestApmInitOneTimeProductBlik","kind":"json-schema","title":"RequestApmInitOneTimeProductBlik","data":{"title":"RequestApmInitOneTimeProductBlik","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","billing_address","ip_address","platform","payment_method_flow"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["blik"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"payment_method_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" according to this method."},"children":[]}]}]}],"enum":["direct","redirect"]},"future_usage":{"$ref":"#/components/schemas/SchemaApmFutureUsageBlikOneTimeProduct"},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":"User-agent string of the device used by the customer.","minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataBlikCode"}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/SchemaApmFutureUsageBlikBnplOneTimeProduct":{"id":"components/schemas/SchemaApmFutureUsageBlikBnplOneTimeProduct","kind":"json-schema","title":"Future usage for Blik Pay Later one-time product payment","data":{"title":"Future usage for Blik Pay Later one-time product payment","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}}},"components/schemas/RequestApmInitOneTimeProductBlikBnpl":{"id":"components/schemas/RequestApmInitOneTimeProductBlikBnpl","kind":"json-schema","title":"RequestApmInitOneTimeProductBlikBnpl","data":{"title":"RequestApmInitOneTimeProductBlikBnpl","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","billing_address","ip_address","platform","payment_method_flow"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik/blik-pay-later/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["blik-bnpl"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"payment_method_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" according to this method."},"children":[]}]}]}],"enum":["redirect"]},"future_usage":{"$ref":"#/components/schemas/SchemaApmFutureUsageBlikBnplOneTimeProduct"},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":"User-agent string of the device used by the customer.","minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductBoleto":{"id":"components/schemas/RequestApmInitOneTimeProductBoleto","kind":"json-schema","title":"RequestApmInitOneTimeProductBoleto","data":{"title":"RequestApmInitOneTimeProductBoleto","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","billing_address","ip_address","platform","payment_type_data"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["boleto"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"payment_method_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" according to this method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the field is not specified, the process available in the method is used."},"children":[]}]}]}],"enum":["redirect","direct"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data that is required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"brazil_cpf":{"type":"string","description":"Individual taxpayer registry identification number should be collected and provided for Brazilian customers.","maxLength":11}},"required":["brazil_cpf"]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductEfecty":{"id":"components/schemas/RequestApmInitOneTimeProductEfecty","kind":"json-schema","title":"RequestApmInitOneTimeProductEfecty","data":{"title":"RequestApmInitOneTimeProductEfecty","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","billing_address","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/efecty","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["efecty"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["COP"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":"Public IP address of the cardholder.","maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":"Additional data required for the specific payment method.","properties":{"colombia_cc":{"type":"string","description":"Colombian citizen identifier number.","maxLength":10}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductGcash":{"id":"components/schemas/RequestApmInitOneTimeProductGcash","kind":"json-schema","title":"RequestApmInitOneTimeProductGcash","data":{"title":"RequestApmInitOneTimeProductGcash","type":"object","required":["currency","order_id","order_description","customer_email","customer_first_name","customer_last_name","product_id","customer_account_id","ip_address","platform","payment_method"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["gcash"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"enum":["PHP"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"one-time"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for single payments or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for recurring payments."},"children":[]}]}]}],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The field value is displayed in the customer's GCash transaction history."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductIdeal":{"id":"components/schemas/RequestApmInitOneTimeProductIdeal","kind":"json-schema","title":"RequestApmInitOneTimeProductIdeal","data":{"title":"RequestApmInitOneTimeProductIdeal","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","billing_address","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/ideal","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["ideal"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"To prevent errors, most iDEAL systems reject descriptions containing characters that could cause issues, such as HTML editing codes, which might lead to problems."},"children":[]}]}]}],"maxLength":35},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductKlarnaNetwork":{"id":"components/schemas/RequestApmInitOneTimeProductKlarnaNetwork","kind":"json-schema","title":"RequestApmInitOneTimeProductKlarnaNetwork","data":{"title":"RequestApmInitOneTimeProductKlarnaNetwork","type":"object","required":["order_id","product_id","currency","order_description","customer_email","customer_account_id","ip_address","platform","payment_method","billing_address","item_category"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/klarna/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["klarna-network"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one time purchases, such as upsells or single use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use the local currency for the selected purchase country."},"children":[]}]}]}],"enum":["AUD","CAD","CHF","CZK","DKK","EUR","GBP","HUF","MXN","NOK","NZD","PLN","RON","SEK","USD"]},"future_usage":{"$ref":"#/components/schemas/SchemaApmFutureUsageKlarnaOneTime"},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order description displayed to the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide a clear description of the subscribed product for recurring payments. It is displayed in the Klarna Customer Journey and affects the customer experience."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","minLength":6,"maxLength":100},"customer_first_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's first name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":99},"customer_last_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's last name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":99},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":"Product category sent to Klarna for eligibility and address handling.","enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"format":"iso_code_a3","minLength":3,"maxLength":3},"state":{"type":"string","description":"Billing state or region.","maxLength":99},"city":{"type":"string","description":"City name.","maxLength":99},"zip":{"type":"string","description":"Address zip or postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":99},"line2":{"type":"string","description":"Second line of the address.","maxLength":99}}},"shipping_address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping address details."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the shipping address."},"children":[]}]}]}],"format":"iso_code_a3","minLength":3,"maxLength":3},"state":{"type":"string","description":"Shipping state or region.","maxLength":99},"city":{"type":"string","description":"City name.","maxLength":99},"zip":{"type":"string","description":"Address zip or postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":99},"line2":{"type":"string","description":"Second line of the address.","maxLength":99}}},"payment_type_data":{"type":"object","description":"Additional data required to make payments with Klarna.","oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkSwe"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkNor"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkIta"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkFin"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkEsp"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkDnk"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkUsa"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOtherCountries"}]},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs in ranges 10.0.0.0 to 10.255.255.255, 172.16.0.0 to 172.31.255.255, and 192.168.0.0 to 192.168.255.255 will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":"User agent string of the device used by the customer.","minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductMbway":{"id":"components/schemas/RequestApmInitOneTimeProductMbway","kind":"json-schema","title":"RequestApmInitOneTimeProductMbway","data":{"title":"RequestApmInitOneTimeProductMbway","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","customer_phone","billing_address","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mb-way","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mbway"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"properties":{"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of payment for future usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"one-time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - no token created, for one-off use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1-click"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - token for future CIT without re-entering details"},"children":[]}]}]}]}],"enum":["one-time","1-click"]}}},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"}]},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmInitOneTimeProductMultibanco":{"id":"components/schemas/RequestApmInitOneTimeProductMultibanco","kind":"json-schema","title":"RequestApmInitOneTimeProductMultibanco","data":{"title":"RequestApmInitOneTimeProductMultibanco","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","billing_address","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/multibanco","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["multibanco"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"enum":["EUR"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"minLength":5,"maxLength":15},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmInitOneTimeProductMercadopago":{"id":"components/schemas/RequestApmInitOneTimeProductMercadopago","kind":"json-schema","title":"RequestApmInitOneTimeProductMercadopago","data":{"title":"RequestApmInitOneTimeProductMercadopago","type":"object","required":["order_id","customer_email","customer_first_name","customer_last_name","ip_address","platform","payment_method","payment_type_data","billing_address","product_id","customer_account_id"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mercado-pago","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mercadopago"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil or VAT/PAIS in Argentina."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR."},"children":[]}]}]}],"enum":["ARS","BRL","CLP","COP","MXN","PEN","UYU"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific payment methods. Specify the value that belongs to the user country."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ARG - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"argentina_dni"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", BRA - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"brazil_cpf"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", CHL - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"chile_ci"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", COL - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"colombia_cc"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", MEX - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"mexico_curp"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", PER - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"peru_dni"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", URY - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"uruguay_ci"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoArg"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoBra"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoChl"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoCol"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoMex"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoPer"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoUry"}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductMobilepay":{"id":"components/schemas/RequestApmInitOneTimeProductMobilepay","kind":"json-schema","title":"RequestApmInitOneTimeProductMobilepay","data":{"title":"RequestApmInitOneTimeProductMobilepay","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","customer_first_name","customer_last_name","billing_address","ip_address","platform","future_usage"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mobilepay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mobilepay"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["DKK"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":"User-agent string of the device used by the customer.","minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductOpenbanking":{"id":"components/schemas/RequestApmInitOneTimeProductOpenbanking","kind":"json-schema","title":"RequestApmInitOneTimeProductOpenbanking","data":{"title":"RequestApmInitOneTimeProductOpenbanking","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","item_category","billing_address","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pay-by-bank/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["openbanking"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR","GBP"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":"Type of goods.","enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductOxxo":{"id":"components/schemas/RequestApmInitOneTimeProductOxxo","kind":"json-schema","title":"RequestApmInitOneTimeProductOxxo","data":{"title":"RequestApmInitOneTimeProductOxxo","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","billing_address","ip_address","platform","payment_type_data"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/oxxo","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["oxxo"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["MXN"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data that is required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"mexico_curp":{"type":"string","description":"Unique Population Registry Code.","minLength":18,"maxLength":18}},"required":["mexico_curp"]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmInitOneTimeProductPix":{"id":"components/schemas/RequestApmInitOneTimeProductPix","kind":"json-schema","title":"RequestApmInitOneTimeProductSmartPix","data":{"title":"RequestApmInitOneTimeProductSmartPix","type":"object","required":["order_id","product_id","customer_account_id","customer_email","customer_first_name","customer_last_name","ip_address","platform","payment_method","payment_type_data","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix payments via redirect to the customer’s bank page."},"children":[]}]}]}],"enum":["pix"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the category of the item."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"physical_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - tangible item that can be shipped with proof of delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"digital_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - goods that are stored, delivered, and used in electronic format"},"children":[]}]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"enum":["BRA"]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform, which the customer used at the moment of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data that is required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"brazil_cpf":{"type":"string","description":"Individual taxpayer registry identification number should be collected and provided for Brazilian customers.","maxLength":11}},"required":["brazil_cpf"]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductPixQr":{"id":"components/schemas/RequestApmInitOneTimeProductPixQr","kind":"json-schema","title":"RequestApmInitPaymentPixQr","data":{"title":"RequestApmInitPaymentPixQr","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","customer_first_name","customer_last_name","billing_address","ip_address","platform","payment_type_data"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix payments via redirect to a page with QR."},"children":[]}]}]}],"enum":["pix-qr"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the category of the item."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"physical_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - tangible item that can be shipped with proof of delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"digital_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - goods that are stored, delivered, and used in electronic format"},"children":[]}]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"enum":["BRA"]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform, which the customer used at the moment of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data that is required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"brazil_cpf":{"type":"string","description":"Individual taxpayer registry identification number should be collected and provided for Brazilian customers.","maxLength":11}},"required":["brazil_cpf"]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductPrzelewy24":{"id":"components/schemas/RequestApmInitOneTimeProductPrzelewy24","kind":"json-schema","title":"RequestApmInitOneTimeProductPrzelewy24","data":{"title":"RequestApmInitOneTimeProductPrzelewy24","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","customer_first_name","customer_last_name","billing_address","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/przelewy24","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["przelewy24"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductPse":{"id":"components/schemas/RequestApmInitOneTimeProductPse","kind":"json-schema","title":"RequestApmInitPaymentPSE","data":{"title":"RequestApmInitPaymentPSE","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","billing_address","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pse","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["pse"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["COP"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":"Public IP address of the cardholder.","maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":"Additional data required for the specific payment method.","properties":{"colombia_cc":{"type":"string","description":"Colombian citizen identifier number.","maxLength":10}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductSencillito":{"id":"components/schemas/RequestApmInitOneTimeProductSencillito","kind":"json-schema","title":"RequestApmInitOneTimeProductSencillito","data":{"title":"RequestApmInitOneTimeProductSencillito","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","billing_address","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/sencillito","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["sencillito"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["CLP"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":"Public IP address of the cardholder.","maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":"Additional data required for the specific payment method.","properties":{"chile_ci":{"type":"string","description":"Chilean citizen identifier number.","maxLength":9}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductServipag":{"id":"components/schemas/RequestApmInitOneTimeProductServipag","kind":"json-schema","title":"RequestApmInitOneTimeProductServipag","data":{"title":"RequestApmInitOneTimeProductServipag","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","billing_address","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/servipag","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["servipag"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["CLP"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":"Public IP address of the cardholder.","maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":"Additional data required for the specific payment method.","properties":{"chile_ci":{"type":"string","description":"Chilean citizen identifier number.","maxLength":9}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/SchemaApmFutureUsageUpiOneTimeProduct":{"id":"components/schemas/SchemaApmFutureUsageUpiOneTimeProduct","kind":"json-schema","title":"unscheduled","data":{"title":"unscheduled","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials for product-based UPI payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for subsequent merchant-initiated charges. Optional "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"max_amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sets a custom authorization ceiling."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["unscheduled"]},"max_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum authorized charge amount per transaction in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for INR."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0}}}},"components/schemas/RequestApmInitOneTimeProductUpi":{"id":"components/schemas/RequestApmInitOneTimeProductUpi","kind":"json-schema","title":"RequestApmInitOneTimeProductUpi","data":{"title":"RequestApmInitOneTimeProductUpi","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","billing_address","ip_address","platform","payment_method_flow","future_usage"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["upi"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["INR"]},"payment_method_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" according to this method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"direct"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for UPI Collect with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"india_vpa"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"redirect"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for UPI Intent; the customer authorizes via the deep link in the response."},"children":[]}]}]}],"enum":["direct","redirect"]},"future_usage":{"$ref":"#/components/schemas/SchemaApmFutureUsageUpiOneTimeProduct"},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"$ref":"#/components/schemas/SchemaApmBillingAddressUpi"},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":"User-agent string of the device used by the customer.","minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataUpiVpa"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataUpiRedirect"}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductWebpay":{"id":"components/schemas/RequestApmInitOneTimeProductWebpay","kind":"json-schema","title":"RequestApmInitOneTimeProductWebpay","data":{"title":"RequestApmInitOneTimeProductWebpay","type":"object","required":["payment_method","order_id","product_id","customer_account_id","customer_email","billing_address","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/webpay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["CLP"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":"Public IP address of the cardholder.","maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":"Additional data required for the specific payment method.","properties":{"chile_ci":{"type":"string","description":"Chilean citizen identifier number.","maxLength":9}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductWechatpay":{"id":"components/schemas/RequestApmInitOneTimeProductWechatpay","kind":"json-schema","title":"RequestApmInitOneTimeProductWechatpay","data":{"title":"RequestApmInitOneTimeProductWechatpay","type":"object","required":["order_id","product_id","order_description","customer_account_id","customer_email","ip_address","platform","payment_method","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["wechatpay"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"default":"CNY"},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"one-time"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for single payments or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for recurring payments."},"children":[]}]}]}],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["one-time"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The field value is displayed in the customer's WeChat Pay transaction history."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client platform used to determine how the payer authorization journey is started."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP starts authorization in an app context, MOB follows a mobile browser path, WEB uses a desktop browser path."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitOneTimeProductDiscriminator":{"id":"components/schemas/RequestApmInitOneTimeProductDiscriminator","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","type":"object","discriminator":{"propertyName":"payment_method","mapping":{"paypal-vault":"#/components/schemas/RequestApmInitOneTimeProductPaypal","alipay":"#/components/schemas/RequestApmInitOneTimeProductAlipay","blik":"#/components/schemas/RequestApmInitOneTimeProductBlik","blik-bnpl":"#/components/schemas/RequestApmInitOneTimeProductBlikBnpl","boleto":"#/components/schemas/RequestApmInitOneTimeProductBoleto","efecty":"#/components/schemas/RequestApmInitOneTimeProductEfecty","gcash":"#/components/schemas/RequestApmInitOneTimeProductGcash","ideal":"#/components/schemas/RequestApmInitOneTimeProductIdeal","klarna-network":"#/components/schemas/RequestApmInitOneTimeProductKlarnaNetwork","mbway":"#/components/schemas/RequestApmInitOneTimeProductMbway","multibanco":"#/components/schemas/RequestApmInitOneTimeProductMultibanco","mercadopago":"#/components/schemas/RequestApmInitOneTimeProductMercadopago","mobilepay":"#/components/schemas/RequestApmInitOneTimeProductMobilepay","openbanking":"#/components/schemas/RequestApmInitOneTimeProductOpenbanking","oxxo":"#/components/schemas/RequestApmInitOneTimeProductOxxo","pix":"#/components/schemas/RequestApmInitOneTimeProductPix","pix-qr":"#/components/schemas/RequestApmInitOneTimeProductPixQr","przelewy24":"#/components/schemas/RequestApmInitOneTimeProductPrzelewy24","pse":"#/components/schemas/RequestApmInitOneTimeProductPse","sencillito":"#/components/schemas/RequestApmInitOneTimeProductSencillito","servipag":"#/components/schemas/RequestApmInitOneTimeProductServipag","upi":"#/components/schemas/RequestApmInitOneTimeProductUpi","webpay":"#/components/schemas/RequestApmInitOneTimeProductWebpay","wechatpay":"#/components/schemas/RequestApmInitOneTimeProductWechatpay"}}}},"components/schemas/RequestApmInitSubscriptionPaypal":{"id":"components/schemas/RequestApmInitSubscriptionPaypal","kind":"json-schema","title":"RequestApmSubscriptionPaypal","data":{"title":"RequestApmSubscriptionPaypal","type":"object","required":["order_id","customer_email","ip_address","platform","payment_method","product_id","customer_account_id","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["paypal-vault"]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the init-payment subscription and one-time payments, the field value is displayed on the user's PayPal statement."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription payments, this field is configured in the product settings as Public description when "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#edit-product","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"editing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" a product via Hub."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security."},"children":[]}]}]}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitSubscriptionAlipay":{"id":"components/schemas/RequestApmInitSubscriptionAlipay","kind":"json-schema","title":"RequestApmSubscriptionAlipay","data":{"title":"RequestApmSubscriptionAlipay","type":"object","required":["order_id","product_id","order_description","customer_account_id","customer_email","customer_phone","ip_address","platform","payment_method","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["alipay"]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR."},"children":[]}]}]}],"minLength":3,"maxLength":3,"default":"CNY"},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"one-time"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for single payments or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for recurring payments."},"children":[]}]}]}],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["unscheduled"]}}},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client platform used to select the appropriate customer confirmation path during checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP opens authorization in an app context, MOB continues in mobile web, WEB runs a desktop browser flow."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security."},"children":[]}]}]}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/SchemaApmFutureUsageBlikSubscription":{"id":"components/schemas/SchemaApmFutureUsageBlikSubscription","kind":"json-schema","title":"Future usage for Blik subscription payment","data":{"title":"Future usage for Blik subscription payment","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["unscheduled"]}}}},"components/schemas/RequestApmInitSubscriptionBlik":{"id":"components/schemas/RequestApmInitSubscriptionBlik","kind":"json-schema","title":"RequestApmSubscriptionBlik","data":{"title":"RequestApmSubscriptionBlik","type":"object","required":["order_id","product_id","customer_email","customer_account_id","ip_address","platform","payment_method","billing_address","future_usage","payment_method_flow","payment_type_data","user_agent"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["blik"]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"payment_method_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" according to this method."},"children":[]}]}]}],"enum":["direct"]},"future_usage":{"$ref":"#/components/schemas/SchemaApmFutureUsageBlikSubscription"},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}],"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":"User-agent string of the device used by the customer.","minLength":1,"maxLength":1000},"payment_type_data":{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataBlikCode"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitSubscriptionGcash":{"id":"components/schemas/RequestApmInitSubscriptionGcash","kind":"json-schema","title":"RequestApmSubscriptionGcash","data":{"title":"RequestApmSubscriptionGcash","type":"object","required":["order_id","customer_email","customer_first_name","customer_last_name","customer_account_id","product_id","ip_address","platform","payment_method"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["gcash"]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR."},"children":[]}]}]}],"minLength":3,"maxLength":3,"enum":["PHP"],"default":"PHP"},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"one-time"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for single payments or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for recurring payments."},"children":[]}]}]}],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["unscheduled"]}}},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security."},"children":[]}]}]}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/SchemaApmFutureUsageKlarnaRecurringProduct":{"id":"components/schemas/SchemaApmFutureUsageKlarnaRecurringProduct","kind":"json-schema","title":"recurring","data":{"title":"recurring","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring Klarna authorization when billing is taken from a Solidgate product."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Do not send "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"billing_amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"billing_period"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_price_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is provided."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["recurring"]}}}},"components/schemas/RequestApmInitSubscriptionKlarnaNetwork":{"id":"components/schemas/RequestApmInitSubscriptionKlarnaNetwork","kind":"json-schema","title":"RequestApmInitSubscriptionKlarnaNetwork","data":{"title":"RequestApmInitSubscriptionKlarnaNetwork","type":"object","required":["order_id","product_id","currency","order_description","customer_email","customer_account_id","ip_address","platform","payment_method","billing_address","item_category"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/klarna/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["klarna-network"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one time purchases, such as upsells or single use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use the local currency for the selected purchase country."},"children":[]}]}]}],"enum":["AUD","CAD","CHF","CZK","DKK","EUR","GBP","HUF","MXN","NOK","NZD","PLN","RON","SEK","USD"]},"future_usage":{"$ref":"#/components/schemas/SchemaApmFutureUsageKlarnaRecurringProduct"},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order description displayed to the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide a clear description of the subscribed product for recurring payments. It is displayed in the Klarna Customer Journey and affects the customer experience."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","minLength":6,"maxLength":100},"customer_first_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's first name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":99},"customer_last_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's last name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":99},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":"Product category sent to Klarna for eligibility and address handling.","enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"format":"iso_code_a3","minLength":3,"maxLength":3},"state":{"type":"string","description":"Billing state or region.","maxLength":99},"city":{"type":"string","description":"City name.","maxLength":99},"zip":{"type":"string","description":"Address zip or postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":99},"line2":{"type":"string","description":"Second line of the address.","maxLength":99}}},"shipping_address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping address details."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the shipping address."},"children":[]}]}]}],"format":"iso_code_a3","minLength":3,"maxLength":3},"state":{"type":"string","description":"Shipping state or region.","maxLength":99},"city":{"type":"string","description":"City name.","maxLength":99},"zip":{"type":"string","description":"Address zip or postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":99},"line2":{"type":"string","description":"Second line of the address.","maxLength":99}}},"payment_type_data":{"type":"object","description":"Additional data required to make payments with Klarna.","oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkSwe"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkNor"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkIta"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkFin"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkEsp"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkDnk"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkUsa"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOtherCountries"}]},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs in ranges 10.0.0.0 to 10.255.255.255, 172.16.0.0 to 172.31.255.255, and 192.168.0.0 to 192.168.255.255 will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":"User agent string of the device used by the customer.","minLength":1,"maxLength":1000},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitSubscriptionMbway":{"id":"components/schemas/RequestApmInitSubscriptionMbway","kind":"json-schema","title":"RequestApmSubscriptionMbway","data":{"title":"RequestApmSubscriptionMbway","type":"object","required":["order_id","product_id","order_description","customer_account_id","customer_email","customer_phone","ip_address","platform","payment_method","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mb-way","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mbway"]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR."},"children":[]}]}]}],"enum":["EUR"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["recurring"]}}},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the init-payment subscription and one-time payments, the field value is displayed on the user's payment statement."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription payments, this field is configured in the product settings as Public description when "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/#edit-product","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"editing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" a product via Hub."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security."},"children":[]}]}]}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitSubscriptionMercadopago":{"id":"components/schemas/RequestApmInitSubscriptionMercadopago","kind":"json-schema","title":"RequestApmSubscriptionMercadopago","data":{"title":"RequestApmSubscriptionMercadopago","type":"object","required":["order_id","customer_email","customer_first_name","customer_last_name","ip_address","platform","payment_method","payment_type_data","billing_address","product_id","customer_account_id"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mercado-pago","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mercadopago"]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil or VAT/PAIS in Argentina."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR."},"children":[]}]}]}],"enum":["ARS","BRL","CLP","COP","MXN","PEN","UYU"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific payment methods. Specify the value that belongs to the user country."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ARG - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"argentina_dni"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", BRA - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"brazil_cpf"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", CHL - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"chile_ci"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", COL - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"colombia_cc"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", MEX - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"mexico_curp"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", PER - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"peru_dni"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", URY - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"uruguay_ci"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoArg"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoBra"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoChl"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoCol"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoMex"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoPer"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataMercadopagoUry"}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitSubscriptionPix":{"id":"components/schemas/RequestApmInitSubscriptionPix","kind":"json-schema","title":"RequestApmSubscriptionSmartPix","data":{"title":"RequestApmSubscriptionSmartPix","type":"object","required":["order_id","product_id","customer_account_id","customer_email","customer_first_name","customer_last_name","ip_address","platform","payment_method","payment_type_data","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix payments via redirect to the customer’s bank page."},"children":[]}]}]}],"enum":["pix"]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product identifier of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the category of the item."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"physical_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - tangible item that can be shipped with proof of delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"digital_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - goods that are stored, delivered, and used in electronic format"},"children":[]}]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"enum":["BRA"]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform, which the customer used at the moment of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data that is required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"brazil_cpf":{"type":"string","description":"Individual taxpayer registry identification number should be collected and provided for Brazilian customers.","maxLength":11}},"required":["brazil_cpf"]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/SchemaApmFutureUsagePixAutomaticoProductCeiling":{"id":"components/schemas/SchemaApmFutureUsagePixAutomaticoProductCeiling","kind":"json-schema","title":"Pix Automático future usage product ceiling","data":{"title":"Pix Automático future usage product ceiling","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pix Automático authorization ceiling settings for product-based and subscription payments."},"children":[]}]}]}],"properties":{"max_amount":{"type":"integer","description":"Maximum authorized charge amount per billing cycle in the smallest currency unit for BRL.","exclusiveMinimum":true,"minimum":0}}}},"components/schemas/RequestApmInitSubscriptionPixAutomatico":{"id":"components/schemas/RequestApmInitSubscriptionPixAutomatico","kind":"json-schema","title":"RequestApmSubscriptionPixAutomatico","data":{"title":"RequestApmSubscriptionPixAutomatico","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pix Automático subscription init."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Optional "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage.max_amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sets a custom authorization ceiling. For subscription payment, sending "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage.billing_period"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" results in a validation error."},"children":[]}]}]}],"required":["order_id","product_id","customer_account_id","customer_email","customer_first_name","customer_last_name","ip_address","platform","payment_method","payment_type_data","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["pix-automatico"]},"order_id":{"type":"string","description":"Unique order identifier, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product identifier of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use for product-based billing plans approved by the Central Bank of Brazil."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"future_usage":{"$ref":"#/components/schemas/SchemaApmFutureUsagePixAutomaticoProductCeiling"},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the category of the item."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"physical_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - tangible item that can be shipped with proof of delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"digital_goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - goods that are stored, delivered, and used in electronic format"},"children":[]}]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"enum":["BRA"]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}},"required":["country"]},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform, which the customer used at the moment of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User-agent string of the customer's device, including browser version and operating system."},"children":[]}]}]}],"minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data that is required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"brazil_cpf":{"type":"string","description":"Individual taxpayer registry identification number should be collected and provided for Brazilian customers.","maxLength":11}},"required":["brazil_cpf"]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/SchemaApmFutureUsageUpiSubscription":{"id":"components/schemas/SchemaApmFutureUsageUpiSubscription","kind":"json-schema","title":"recurring","data":{"title":"recurring","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines recurring mandate parameters for product-based UPI subscriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_method_flow"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"redirect"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for UPI Intent. Optional "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"max_amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sets a custom authorization ceiling. For subscription payment, sending "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage.billing_period"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" results in a validation error because the billing plan is taken from the Solidgate product."},"children":[]}]}]}],"required":["payment_type"],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["recurring"]},"max_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum authorized charge amount per billing cycle in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for INR."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0}}}},"components/schemas/SchemaApmFutureUsageUpiSubscriptionRedirect":{"id":"components/schemas/SchemaApmFutureUsageUpiSubscriptionRedirect","kind":"json-schema","title":"redirect","data":{"title":"redirect","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"redirect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UPI Intent) flow."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmFutureUsageUpiSubscription"},{"$ref":"#/components/schemas/SchemaApmFutureUsageUpiUnscheduled"}]}},"components/schemas/RequestApmInitSubscriptionUpi":{"id":"components/schemas/RequestApmInitSubscriptionUpi","kind":"json-schema","title":"RequestApmInitSubscriptionUpi","data":{"title":"RequestApmInitSubscriptionUpi","type":"object","required":["order_id","product_id","customer_email","customer_account_id","ip_address","platform","payment_method","billing_address","future_usage","payment_method_flow"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["upi"]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["INR"]},"payment_method_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" according to this method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"direct"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for UPI Collect with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"india_vpa"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"redirect"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for UPI Intent; the customer authorizes via the deep link in the response."},"children":[]}]}]}],"enum":["direct","redirect"]},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmFutureUsageUpiDirect"},{"$ref":"#/components/schemas/SchemaApmFutureUsageUpiSubscriptionRedirect"}]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"$ref":"#/components/schemas/SchemaApmBillingAddressUpi"},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":"User-agent string of the device used by the customer.","minLength":1,"maxLength":1000},"payment_type_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataUpiVpa"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataUpiRedirect"}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitSubscriptionWechatpay":{"id":"components/schemas/RequestApmInitSubscriptionWechatpay","kind":"json-schema","title":"RequestApmSubscriptionWechatpay","data":{"title":"RequestApmSubscriptionWechatpay","type":"object","required":["order_id","product_id","customer_email","customer_account_id","customer_phone","ip_address","platform","payment_method","billing_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["wechatpay"]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR."},"children":[]}]}]}],"minLength":3,"maxLength":3,"default":"CNY"},"future_usage":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/init-alternative-payment/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of stored payment credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"one-time"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for single payments or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for recurring payments."},"children":[]}]}]}],"properties":{"payment_type":{"type":"string","description":"Type of payment for future usage.","enum":["unscheduled"]}}},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"item_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"shipping_address"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" details for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["physical_goods","digital_goods"]},"billing_address":{"type":"object","description":"Billing address details.","required":["country"],"properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code of the billing address."},"children":[]}]}]}],"minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-2","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address state code of the billing address."},"children":[]}]}]}],"maxLength":100},"city":{"type":"string","description":"City name.","maxLength":100},"zip":{"type":"string","description":"Address zip/postal code.","maxLength":10},"line1":{"type":"string","description":"First line of the address.","maxLength":200},"line2":{"type":"string","description":"Second line of the address.","maxLength":200}}},"shipping_address":{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client platform used to determine how the payer authorization journey is started."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP starts authorization in an app context, MOB follows a mobile browser path, WEB uses a desktop browser path."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"user_agent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-agent string of the device used by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security."},"children":[]}]}]}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"success_url":{"type":"string","description":"URL for browser redirect after a successful payment.","maxLength":255},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255},"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255}}}},"components/schemas/RequestApmInitSubscriptionDiscriminator":{"id":"components/schemas/RequestApmInitSubscriptionDiscriminator","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","type":"object","discriminator":{"propertyName":"payment_method","mapping":{"paypal-vault":"#/components/schemas/RequestApmInitSubscriptionPaypal","alipay":"#/components/schemas/RequestApmInitSubscriptionAlipay","blik":"#/components/schemas/RequestApmInitSubscriptionBlik","gcash":"#/components/schemas/RequestApmInitSubscriptionGcash","klarna-network":"#/components/schemas/RequestApmInitSubscriptionKlarnaNetwork","mbway":"#/components/schemas/RequestApmInitSubscriptionMbway","mercadopago":"#/components/schemas/RequestApmInitSubscriptionMercadopago","pix":"#/components/schemas/RequestApmInitSubscriptionPix","pix-automatico":"#/components/schemas/RequestApmInitSubscriptionPixAutomatico","upi":"#/components/schemas/RequestApmInitSubscriptionUpi","wechatpay":"#/components/schemas/RequestApmInitSubscriptionWechatpay"}}}},"components/schemas/SchemaApmOrderResponsePaypal":{"id":"components/schemas/SchemaApmOrderResponsePaypal","kind":"json-schema","title":"SchemaApmOrderResponsePayPal","data":{"title":"SchemaApmOrderResponsePayPal","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"paypal-vault"},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For COP, CRC, HUF, LAK, RSD, and TWD, should pass the integer value of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with two zeros at the end (for example, XXXX00, which will be transferred as XXXX.00). The value 0 is valid only for obtaining a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/#billing-agreement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"billing agreement token"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (recurring-token)."},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseAlipay":{"id":"components/schemas/SchemaApmOrderResponseAlipay","kind":"json-schema","title":"SchemaApmOrderResponseAlipay","data":{"title":"SchemaApmOrderResponseAlipay","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"alipay"},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For CNY currency, the amount is in cents (e.g., 8900 = 89.00 CNY)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseBlik":{"id":"components/schemas/SchemaApmOrderResponseBlik","kind":"json-schema","title":"SchemaApmOrderResponseBlik","data":{"title":"SchemaApmOrderResponseBlik","type":"object","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"blik"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseBlikBnpl":{"id":"components/schemas/SchemaApmOrderResponseBlikBnpl","kind":"json-schema","title":"SchemaApmOrderResponseBlikBnpl","data":{"title":"SchemaApmOrderResponseBlikBnpl","type":"object","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik/blik-pay-later/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"blik-bnpl"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseBizum":{"id":"components/schemas/SchemaApmOrderResponseBizum","kind":"json-schema","title":"SchemaApmOrderResponseBizum","data":{"title":"SchemaApmOrderResponseBizum","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/bizum/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"bizum"},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For EUR currency, the amount is in cents (e.g., 400 = 4.00 EUR)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseBoleto":{"id":"components/schemas/SchemaApmOrderResponseBoleto","kind":"json-schema","title":"SchemaApmOrderResponseBoleto","data":{"title":"SchemaApmOrderResponseBoleto","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"boleto"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identidier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseCashapp":{"id":"components/schemas/SchemaApmOrderResponseCashapp","kind":"json-schema","title":"SchemaApmOrderResponseCashapp","data":{"title":"SchemaApmOrderResponseCashapp","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/cash-app-pay/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"cashapp"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For USD currency, the amount is in cents (e.g., 1020 = 10.20 USD)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"enum":["USD"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseEfecty":{"id":"components/schemas/SchemaApmOrderResponseEfecty","kind":"json-schema","title":"SchemaApmOrderResponseEfecty","data":{"title":"SchemaApmOrderResponseEfecty","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"efecty"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["COP"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseGcash":{"id":"components/schemas/SchemaApmOrderResponseGcash","kind":"json-schema","title":"SchemaApmOrderResponseGcash","data":{"title":"SchemaApmOrderResponseGcash","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"gcash"},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For PHP currency, the amount is in cents, for example, 2575 = 25.75 PHP."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseIdeal":{"id":"components/schemas/SchemaApmOrderResponseIdeal","kind":"json-schema","title":"SchemaApmOrderResponseIdeal","data":{"title":"SchemaApmOrderResponseIdeal","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"ideal"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","settle_pending","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseKlarnaNetwork":{"id":"components/schemas/SchemaApmOrderResponseKlarnaNetwork","kind":"json-schema","title":"SchemaApmOrderResponseKlarnaNetwork","data":{"title":"SchemaApmOrderResponseKlarnaNetwork","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/klarna/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"klarna-network"},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["AUD","CAD","CHF","CZK","DKK","EUR","GBP","HUF","MXN","NOK","NZD","PLN","RON","SEK","USD"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","settle_pending","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs in ranges 10.0.0.0 to 10.255.255.255, 172.16.0.0 to 172.31.255.255, and 192.168.0.0 to 192.168.255.255 will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseMbway":{"id":"components/schemas/SchemaApmOrderResponseMbway","kind":"json-schema","title":"SchemaApmOrderResponseMbway","data":{"title":"SchemaApmOrderResponseMbway","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"mbway"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseMercadopago":{"id":"components/schemas/SchemaApmOrderResponseMercadopago","kind":"json-schema","title":"SchemaApmOrderResponseMercadopago","data":{"title":"SchemaApmOrderResponseMercadopago","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"mercadopago"},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["ARS","BRL","CLP","COP","MXN","PEN","UYU"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseMobilepay":{"id":"components/schemas/SchemaApmOrderResponseMobilepay","kind":"json-schema","title":"SchemaApmOrderResponseMobilepay","data":{"title":"SchemaApmOrderResponseMobilepay","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mobilepay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"mobilepay"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["DKK"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseMultibanco":{"id":"components/schemas/SchemaApmOrderResponseMultibanco","kind":"json-schema","title":"SchemaApmOrderResponseMultibanco","data":{"title":"SchemaApmOrderResponseMultibanco","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/multibanco","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"multibanco"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For EUR currency, the amount is in cents (e.g., 2490 = 24.90 EUR)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseOpenbanking":{"id":"components/schemas/SchemaApmOrderResponseOpenbanking","kind":"json-schema","title":"SchemaApmOrderResponseOpenbanking","data":{"title":"SchemaApmOrderResponseOpenbanking","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pay-by-bank/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"enum":["openbanking"]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR","GBP"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","settle_pending","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseOxxo":{"id":"components/schemas/SchemaApmOrderResponseOxxo","kind":"json-schema","title":"SchemaApmOrderResponseOxxo","data":{"title":"SchemaApmOrderResponseOxxo","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/oxxo/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"oxxo"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["MXN"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponsePix":{"id":"components/schemas/SchemaApmOrderResponsePix","kind":"json-schema","title":"SchemaApmOrderResponseSmartPix","data":{"title":"SchemaApmOrderResponseSmartPix","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix payments via redirect to the customer’s bank page."},"children":[]}]}]}],"example":"pix"},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponsePixQr":{"id":"components/schemas/SchemaApmOrderResponsePixQr","kind":"json-schema","title":"SchemaApmOrderResponsePixQr","data":{"title":"SchemaApmOrderResponsePixQr","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix payments via redirect to a page with QR."},"children":[]}]}]}],"example":"pix-qr"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponsePixAutomatico":{"id":"components/schemas/SchemaApmOrderResponsePixAutomatico","kind":"json-schema","title":"SchemaApmOrderResponsePixAutomatico","data":{"title":"SchemaApmOrderResponsePixAutomatico","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"pix-automatico"},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandate or stored credential token for subsequent scheduled charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Present on recurring flows after the customer has authorized the mandate. Use it with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/alternative-payment-methods/make-apm-recurring","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" endpoint."},"children":[]}]}]}],"maxLength":255},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponsePrzelewy24":{"id":"components/schemas/SchemaApmOrderResponsePrzelewy24","kind":"json-schema","title":"SchemaApmOrderResponsePrzelewy24","data":{"title":"SchemaApmOrderResponsePrzelewy24","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/przelewy24/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"przelewy24"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponsePse":{"id":"components/schemas/SchemaApmOrderResponsePse","kind":"json-schema","title":"SchemaApmOrderResponsePse","data":{"title":"SchemaApmOrderResponsePse","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"pse"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["COP"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseSencillito":{"id":"components/schemas/SchemaApmOrderResponseSencillito","kind":"json-schema","title":"SchemaApmOrderResponseSencillito","data":{"title":"SchemaApmOrderResponseSencillito","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"sencillito"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["CLP"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseServipag":{"id":"components/schemas/SchemaApmOrderResponseServipag","kind":"json-schema","title":"SchemaApmOrderResponseServipag","data":{"title":"SchemaApmOrderResponseServipag","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"servipag"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["CLP"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseUpi":{"id":"components/schemas/SchemaApmOrderResponseUpi","kind":"json-schema","title":"SchemaApmOrderResponseUpi","data":{"title":"SchemaApmOrderResponseUpi","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"upi"},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["INR"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseWebpay":{"id":"components/schemas/SchemaApmOrderResponseWebpay","kind":"json-schema","title":"SchemaApmOrderResponseWebpay","data":{"title":"SchemaApmOrderResponseWebpay","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"webpay"},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["CLP"]},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmOrderResponseWechatpay":{"id":"components/schemas/SchemaApmOrderResponseWechatpay","kind":"json-schema","title":"SchemaApmOrderResponseWechatpay","data":{"title":"SchemaApmOrderResponseWechatpay","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}],"example":"wechatpay"},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For CNY currency, the amount is in cents (e.g., 8900 = 89.00 CNY)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50}}}},"components/schemas/SchemaApmDiscriminatorResponseOrder":{"id":"components/schemas/SchemaApmDiscriminatorResponseOrder","kind":"json-schema","title":"SchemaApmDiscriminatorResponseOrder","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of an order, including identifiers, timestamps, amounts, status, and customer data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order's structure may vary depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used."},"children":[]}]}]}],"properties":{"method":{"type":"string"}},"discriminator":{"propertyName":"method","mapping":{"paypal-vault":"#/components/schemas/SchemaApmOrderResponsePaypal","alipay":"#/components/schemas/SchemaApmOrderResponseAlipay","blik":"#/components/schemas/SchemaApmOrderResponseBlik","blik-bnpl":"#/components/schemas/SchemaApmOrderResponseBlikBnpl","bizum":"#/components/schemas/SchemaApmOrderResponseBizum","boleto":"#/components/schemas/SchemaApmOrderResponseBoleto","cashapp":"#/components/schemas/SchemaApmOrderResponseCashapp","efecty":"#/components/schemas/SchemaApmOrderResponseEfecty","gcash":"#/components/schemas/SchemaApmOrderResponseGcash","ideal":"#/components/schemas/SchemaApmOrderResponseIdeal","klarna-network":"#/components/schemas/SchemaApmOrderResponseKlarnaNetwork","mbway":"#/components/schemas/SchemaApmOrderResponseMbway","mercadopago":"#/components/schemas/SchemaApmOrderResponseMercadopago","mobilepay":"#/components/schemas/SchemaApmOrderResponseMobilepay","multibanco":"#/components/schemas/SchemaApmOrderResponseMultibanco","openbanking":"#/components/schemas/SchemaApmOrderResponseOpenbanking","oxxo":"#/components/schemas/SchemaApmOrderResponseOxxo","pix":"#/components/schemas/SchemaApmOrderResponsePix","pix-qr":"#/components/schemas/SchemaApmOrderResponsePixQr","pix-automatico":"#/components/schemas/SchemaApmOrderResponsePixAutomatico","przelewy24":"#/components/schemas/SchemaApmOrderResponsePrzelewy24","pse":"#/components/schemas/SchemaApmOrderResponsePse","sencillito":"#/components/schemas/SchemaApmOrderResponseSencillito","servipag":"#/components/schemas/SchemaApmOrderResponseServipag","upi":"#/components/schemas/SchemaApmOrderResponseUpi","webpay":"#/components/schemas/SchemaApmOrderResponseWebpay","wechatpay":"#/components/schemas/SchemaApmOrderResponseWechatpay"}}}},"components/schemas/SchemaApmTransactionsResponsePaypal":{"id":"components/schemas/SchemaApmTransactionsResponsePaypal","kind":"json-schema","title":"SchemaApmTransactionsResponsePaypal","data":{"title":"SchemaApmTransactionsResponsePaypal","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"paypal-vault"},"id":{"type":"string","description":"Unique identifier associated with a transaction.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For COP, CRC, HUF, LAK, RSD, and TWD, should pass the integer value of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with two zeros at the end (for example, XXXX00, which will be transferred as XXXX.00). The value 0 is valid only for obtaining a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/#billing-agreement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"billing agreement token"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (recurring-token)."},"children":[]}]}]}],"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]},"payer_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information such as the payer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}],"type":"object","deprecated":true,"properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal.","example":"123443334","deprecated":true},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}],"deprecated":true}}}}}},"components/schemas/SchemaApmTransactionsResponseAlipay":{"id":"components/schemas/SchemaApmTransactionsResponseAlipay","kind":"json-schema","title":"SchemaApmTransactionsResponseAlipay","data":{"title":"SchemaApmTransactionsResponseAlipay","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"alipay"},"id":{"type":"string","description":"Unique identifier associated with a transaction.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For CNY currency, the amount is in cents (e.g., 8900 = 89.00 CNY)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseBlik":{"id":"components/schemas/SchemaApmTransactionsResponseBlik","kind":"json-schema","title":"SchemaApmTransactionsResponseBlik","data":{"title":"SchemaApmTransactionsResponseBlik","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"blik"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseBlikBnpl":{"id":"components/schemas/SchemaApmTransactionsResponseBlikBnpl","kind":"json-schema","title":"SchemaApmTransactionsResponseBlikBnpl","data":{"title":"SchemaApmTransactionsResponseBlikBnpl","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik/blik-pay-later/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"blik-bnpl"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseBizum":{"id":"components/schemas/SchemaApmTransactionsResponseBizum","kind":"json-schema","title":"SchemaApmTransactionsResponseBizum","data":{"title":"SchemaApmTransactionsResponseBizum","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"bizum"},"id":{"type":"string","description":"Unique identifier associated with a transaction.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For EUR currency, the amount is in cents (e.g., 400 = 4.00 EUR)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseBoleto":{"id":"components/schemas/SchemaApmTransactionsResponseBoleto","kind":"json-schema","title":"SchemaApmTransactionsResponseBoleto","data":{"title":"SchemaApmTransactionsResponseBoleto","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"boleto"},"id":{"type":"string","description":"Unique identifier associated with a transaction.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseCashapp":{"id":"components/schemas/SchemaApmTransactionsResponseCashapp","kind":"json-schema","title":"SchemaApmTransactionsResponseCashapp","data":{"title":"SchemaApmTransactionsResponseCashapp","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"cashapp"},"id":{"type":"string","description":"Unique identifier associated with a transaction.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For USD currency, the amount is in cents (e.g., 1020 = 10.20 USD)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"enum":["USD"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseEfecty":{"id":"components/schemas/SchemaApmTransactionsResponseEfecty","kind":"json-schema","title":"SchemaApmTransactionsResponseEfecty","data":{"title":"SchemaApmTransactionsResponseEfecty","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"efecty"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["COP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseGcash":{"id":"components/schemas/SchemaApmTransactionsResponseGcash","kind":"json-schema","title":"SchemaApmTransactionsResponseGcash","data":{"title":"SchemaApmTransactionsResponseGcash","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"gcash"},"id":{"type":"string","description":"Unique identifier associated with a transaction.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For PHP currency, the amount is in cents (e.g., 2575 = 25.75 PHP)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseIdeal":{"id":"components/schemas/SchemaApmTransactionsResponseIdeal","kind":"json-schema","title":"SchemaApmTransactionsResponseIdeal","data":{"title":"SchemaApmTransactionsResponseIdeal","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"ideal"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","settle_pending","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseKlarnaNetwork":{"id":"components/schemas/SchemaApmTransactionsResponseKlarnaNetwork","kind":"json-schema","title":"SchemaApmTransactionsResponseKlarnaNetwork","data":{"title":"SchemaApmTransactionsResponseKlarnaNetwork","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/klarna/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"klarna-network"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["AUD","CAD","CHF","CZK","DKK","EUR","GBP","HUF","MXN","NOK","NZD","PLN","RON","SEK","USD"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","settle_pending","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseMbway":{"id":"components/schemas/SchemaApmTransactionsResponseMbway","kind":"json-schema","title":"SchemaApmTransactionsResponseMbway","data":{"title":"SchemaApmTransactionsResponseMbway","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"mbway"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseMercadopago":{"id":"components/schemas/SchemaApmTransactionsResponseMercadopago","kind":"json-schema","title":"SchemaApmTransactionsResponseMercadopago","data":{"title":"SchemaApmTransactionsResponseMercadopago","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"mercadopago"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["ARS","BRL","CLP","COP","MXN","PEN","UYU"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseMobilepay":{"id":"components/schemas/SchemaApmTransactionsResponseMobilepay","kind":"json-schema","title":"SchemaApmTransactionsResponseMobilepay","data":{"title":"SchemaApmTransactionsResponseMobilepay","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mobilepay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"mobilepay"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["DKK"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseMultibanco":{"id":"components/schemas/SchemaApmTransactionsResponseMultibanco","kind":"json-schema","title":"SchemaApmTransactionsResponseMultibanco","data":{"title":"SchemaApmTransactionsResponseMultibanco","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/multibanco","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"multibanco"},"id":{"type":"string","description":"Unique identifier associated with a transaction.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For EUR currency, the amount is in cents (e.g., 2490 = 24.90 EUR)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseOpenbanking":{"id":"components/schemas/SchemaApmTransactionsResponseOpenbanking","kind":"json-schema","title":"SchemaApmTransactionsResponseOpenbanking","data":{"title":"SchemaApmTransactionsResponseOpenbanking","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pay-by-bank/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"openbanking"},"id":{"type":"string","description":"Unique identifier associated with a transaction.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","settle_pending","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseOxxo":{"id":"components/schemas/SchemaApmTransactionsResponseOxxo","kind":"json-schema","title":"SchemaApmTransactionsResponseOxxo","data":{"title":"SchemaApmTransactionsResponseOxxo","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/oxxo/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"oxxo"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["MXN"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponsePix":{"id":"components/schemas/SchemaApmTransactionsResponsePix","kind":"json-schema","title":"SchemaApmTransactionsResponseSmartPix","data":{"title":"SchemaApmTransactionsResponseSmartPix","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix payments via redirect to the customer’s bank page."},"children":[]}]}]}],"example":"pix"},"id":{"type":"string","description":"Unique identifier associated with a transaction.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponsePixQr":{"id":"components/schemas/SchemaApmTransactionsResponsePixQr","kind":"json-schema","title":"SchemaApmTransactionsResponsePixQr","data":{"title":"SchemaApmTransactionsResponsePixQr","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix payments via redirect to a page with QR."},"children":[]}]}]}],"example":"pix-qr"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponsePixAutomatico":{"id":"components/schemas/SchemaApmTransactionsResponsePixAutomatico","kind":"json-schema","title":"SchemaApmTransactionsResponsePixAutomatico","data":{"title":"SchemaApmTransactionsResponsePixAutomatico","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"pix-automatico"},"id":{"type":"string","description":"Unique identifier associated with a transaction.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"pay"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the initial mandate or a one-off charge. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for subsequent scheduled charges using a stored token."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponsePrzelewy24":{"id":"components/schemas/SchemaApmTransactionsResponsePrzelewy24","kind":"json-schema","title":"SchemaApmTransactionsResponsePrzelewy24","data":{"title":"SchemaApmTransactionsResponsePrzelewy24","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/przelewy24/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"przelewy24"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponsePse":{"id":"components/schemas/SchemaApmTransactionsResponsePse","kind":"json-schema","title":"SchemaApmTransactionsResponsePse","data":{"title":"SchemaApmTransactionsResponsePse","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pse/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"pse"},"id":{"type":"string","description":"Unique identifier associated with a transaction.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["COP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseSencillito":{"id":"components/schemas/SchemaApmTransactionsResponseSencillito","kind":"json-schema","title":"SchemaApmTransactionsResponseSencillito","data":{"title":"SchemaApmTransactionsResponseSencillito","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/sencillito/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"sencillito"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["CLP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseServipag":{"id":"components/schemas/SchemaApmTransactionsResponseServipag","kind":"json-schema","title":"SchemaApmTransactionsResponseServipag","data":{"title":"SchemaApmTransactionsResponseServipag","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/servipag/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"servipag"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["CLP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseUpi":{"id":"components/schemas/SchemaApmTransactionsResponseUpi","kind":"json-schema","title":"SchemaApmTransactionsResponseUpi","data":{"title":"SchemaApmTransactionsResponseUpi","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"upi"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["INR"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseWebpay":{"id":"components/schemas/SchemaApmTransactionsResponseWebpay","kind":"json-schema","title":"SchemaApmTransactionsResponseWebpay","data":{"title":"SchemaApmTransactionsResponseWebpay","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/webpay/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"webpay"},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["CLP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmTransactionsResponseWechatpay":{"id":"components/schemas/SchemaApmTransactionsResponseWechatpay","kind":"json-schema","title":"SchemaApmTransactionsResponseWechatpay","data":{"title":"SchemaApmTransactionsResponseWechatpay","type":"object","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}],"example":"wechatpay"},"id":{"type":"string","description":"Unique identifier associated with a transaction.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For CNY currency, the amount is in cents (e.g., 8900 = 89.00 CNY)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"components/schemas/SchemaApmDiscriminatorResponseTransactions":{"id":"components/schemas/SchemaApmDiscriminatorResponseTransactions","kind":"json-schema","title":"SchemaApmDiscriminatorResponseTransactions","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of transactions, including payment method, identifiers, amounts, currencies, statuses, and types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction's structure may vary depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used."},"children":[]}]}]}],"items":{"type":"object","required":["method"],"properties":{"method":{"type":"string","description":"Payment method used for the transaction."}},"discriminator":{"propertyName":"method","mapping":{"paypal-vault":"#/components/schemas/SchemaApmTransactionsResponsePaypal","alipay":"#/components/schemas/SchemaApmTransactionsResponseAlipay","blik":"#/components/schemas/SchemaApmTransactionsResponseBlik","blik-bnpl":"#/components/schemas/SchemaApmTransactionsResponseBlikBnpl","bizum":"#/components/schemas/SchemaApmTransactionsResponseBizum","boleto":"#/components/schemas/SchemaApmTransactionsResponseBoleto","cashapp":"#/components/schemas/SchemaApmTransactionsResponseCashapp","efecty":"#/components/schemas/SchemaApmTransactionsResponseEfecty","gcash":"#/components/schemas/SchemaApmTransactionsResponseGcash","ideal":"#/components/schemas/SchemaApmTransactionsResponseIdeal","klarna-network":"#/components/schemas/SchemaApmTransactionsResponseKlarnaNetwork","mbway":"#/components/schemas/SchemaApmTransactionsResponseMbway","mercadopago":"#/components/schemas/SchemaApmTransactionsResponseMercadopago","mobilepay":"#/components/schemas/SchemaApmTransactionsResponseMobilepay","multibanco":"#/components/schemas/SchemaApmTransactionsResponseMultibanco","openbanking":"#/components/schemas/SchemaApmTransactionsResponseOpenbanking","oxxo":"#/components/schemas/SchemaApmTransactionsResponseOxxo","pix":"#/components/schemas/SchemaApmTransactionsResponsePix","pix-qr":"#/components/schemas/SchemaApmTransactionsResponsePixQr","pix-automatico":"#/components/schemas/SchemaApmTransactionsResponsePixAutomatico","przelewy24":"#/components/schemas/SchemaApmTransactionsResponsePrzelewy24","pse":"#/components/schemas/SchemaApmTransactionsResponsePse","sencillito":"#/components/schemas/SchemaApmTransactionsResponseSencillito","servipag":"#/components/schemas/SchemaApmTransactionsResponseServipag","upi":"#/components/schemas/SchemaApmTransactionsResponseUpi","webpay":"#/components/schemas/SchemaApmTransactionsResponseWebpay","wechatpay":"#/components/schemas/SchemaApmTransactionsResponseWechatpay"}}}}},"components/schemas/SchemaApmPayForm":{"id":"components/schemas/SchemaApmPayForm","kind":"json-schema","title":"SchemaApmPayForm","data":{"title":"SchemaApmPayForm","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment form data."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Including fields necessary for processing the payment."},"children":[]}]}]}],"properties":{"return_url":{"type":"string","description":"URL for browser redirect after a payment process.","maxLength":255},"script_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the JavaScript file required to render the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-form/apm-buttons/#method-specific-configuration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM payment form"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" during integration, initialization, and configuration."},"children":[]}]}]}],"maxLength":255},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secure payment token representing sensitive payment method information."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Token received on the first payment, which should be used for subsequent payments."},"children":[]}]}]}],"deprecated":true}}}},"components/schemas/SchemaApmPaymentTypeDataResponseBoleto":{"id":"components/schemas/SchemaApmPaymentTypeDataResponseBoleto","kind":"json-schema","title":"Boleto","data":{"title":"Boleto","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This object is specifically for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"boleto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix QR"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" payments."},"children":[]}]}]}],"properties":{"amount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in the currency of the transaction."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}]},"expiration_date":{"type":"string","format":"date","description":"Expiration date."},"image_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the image representing the full "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boleto"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method details."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This provides a visual reference for the user."},"children":[]}]}]}]},"number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ticket number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Long number customers enter in their bank app or website to complete the payment."},"children":[]}]}]}]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This specifies the category of the alternative payment method being used."},"children":[]}]}]}]}}}},"components/schemas/SchemaApmPaymentTypeDataResponseMultibanco":{"id":"components/schemas/SchemaApmPaymentTypeDataResponseMultibanco","kind":"json-schema","title":"Multibanco","data":{"title":"Multibanco","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This object is specifically for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/multibanco","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Multibanco"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" payments."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This specifies the category of the alternative payment method being used."},"children":[]}]}]}],"enum":["multibanco"]},"entity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Five-digit entity code identifying the merchant for Multibanco payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Customers use this code together with the payment reference at an ATM or home banking."},"children":[]}]}]}],"maxLength":5,"minLength":5},"reference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nine-digit payment reference number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Customers enter this reference together with the entity code to complete the payment."},"children":[]}]}]}],"maxLength":9,"minLength":9},"reference_expiration":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 datetime when the Multibanco payment reference expires."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The voucher is active for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"120"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" hours (5 days) from issuance."},"children":[]}]}]}]}}}},"components/schemas/SchemaApmPaymentTypeDataResponsePixQr":{"id":"components/schemas/SchemaApmPaymentTypeDataResponsePixQr","kind":"json-schema","title":"Pix QR","data":{"title":"Pix QR","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QR payload for the customer to complete a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pix QR"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The QR value is valid until "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"qr_code_expiration_date"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"; if it expires, create a new init payment to obtain another code."},"children":[]}]}]}],"properties":{"qr_code_value":{"type":"string","description":"EMV payload for the customer to scan or copy into a Pix app.","maxLength":512},"qr_code_expiration_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Expiration datetime of the QR code."}}}},"components/schemas/SchemaApmPaymentTypeDataResponsePixAutomatico":{"id":"components/schemas/SchemaApmPaymentTypeDataResponsePixAutomatico","kind":"json-schema","title":"Pix Automático","data":{"title":"Pix Automático","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QR payload for the customer to authorize a Pix Automático mandate on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"initial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The QR value is valid for one hour from issuance; if it expires, create a new init payment to obtain another code."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"After successful authorization, a token is issued for subsequent recurring charges in the same billing cycle. See the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/alternative-payment-methods/make-apm-recurring","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" operation."},"children":[]}]}]}],"properties":{"qr_code_value":{"type":"string","description":"EMV payload for the customer to scan or copy into a Pix app.","maxLength":512},"qr_code_expiration_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Expiration datetime of the QR code, usually within one hour after issuance."}}}},"components/schemas/SchemaApmPaymentTypeDataResponseUpi":{"id":"components/schemas/SchemaApmPaymentTypeDataResponseUpi","kind":"json-schema","title":"UPI","data":{"title":"UPI","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deep link for the customer to authorize a UPI Intent or recurring mandate."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Returned with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_method_flow"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"redirect"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Open the link in a UPI-compatible app to complete authorization."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"After successful authorization, a token is issued for subsequent recurring charges. See the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/alternative-payment-methods/make-apm-recurring","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" operation."},"children":[]}]}]}],"properties":{"deep_link_value":{"type":"string","description":"UPI deep link URI for mandate or payment authorization.","maxLength":2048}}}},"components/schemas/ResponseApmSuccess":{"id":"components/schemas/ResponseApmSuccess","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"order":{"$ref":"#/components/schemas/SchemaApmDiscriminatorResponseOrder"},"transactions":{"$ref":"#/components/schemas/SchemaApmDiscriminatorResponseTransactions"},"pay_form":{"allOf":[{"$ref":"#/components/schemas/SchemaApmPayForm"}]},"payment_type_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This object is specifically for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Boleto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/multibanco","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Multibanco"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"24"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"-hour reference validity), "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix QR"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix Automático"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" initial mandate responses with QR payload and expiry, and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"UPI Intent"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" responses with a deep link for mandate authorization."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponseBoleto"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponseMultibanco"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponsePixQr"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponsePixAutomatico"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponseUpi"}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringPaypal":{"id":"components/schemas/RequestApmRecurringPaypal","kind":"json-schema","title":"RequestApmRecurring","data":{"title":"RequestApmRecurring","type":"object","required":["payment_method","token","amount","currency","order_id","order_description","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["paypal-vault"]},"token":{"type":"string","description":"Secure payment token representing sensitive payment method information."},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For COP, CRC, HUF, LAK, RSD, and TWD, should pass the integer value of the amount with two zeros at the end (for example, XXXX00, which will be transferred as XXXX.00)."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringAlipay":{"id":"components/schemas/RequestApmRecurringAlipay","kind":"json-schema","title":"RequestApmRecurringAlipay","data":{"title":"RequestApmRecurringAlipay","type":"object","required":["amount","currency","order_id","order_description","customer_email","customer_phone","ip_address","platform","payment_method","token"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["alipay"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For CNY currency, the amount should be in cents (e.g., 8900 = 89.00 CNY)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"default":"CNY"},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The field value is displayed in the customer's Alipay transaction history."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client platform used to select the appropriate customer confirmation path during checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP opens authorization in an app context, MOB continues in mobile web, WEB runs a desktop browser flow."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringBlik":{"id":"components/schemas/RequestApmRecurringBlik","kind":"json-schema","title":"RequestApmRecurringBlik","data":{"title":"RequestApmRecurringBlik","type":"object","required":["amount","currency","order_id","order_description","customer_email","ip_address","platform","payment_method","token"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["blik"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringGcash":{"id":"components/schemas/RequestApmRecurringGcash","kind":"json-schema","title":"RequestApmRecurring","data":{"title":"RequestApmRecurring","type":"object","required":["payment_method","token","amount","currency","order_id","order_description","customer_email","customer_first_name","customer_last_name","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["gcash"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"enum":["PHP"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkRecurring":{"id":"components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkRecurring","kind":"json-schema","title":"Payment Type Data","data":{"title":"Payment Type Data","type":"object","description":"Klarna boost features and session continuity fields.","properties":{"klarna_network_session_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Klarna Web SDK session token."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for Klarna boost features like Express Checkout, On-Site Messaging, and Sign in with Klarna. Enables session continuity and pre-filled customer details."},"children":[]}]}]}],"maxLength":10240},"klarna_network_data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Klarna Network Data (KND). Structured JSON pass-through carrying Klarna payment context across the payment lifecycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to include supplementary purchase data, for example order line items, as described in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.klarna.com/acquirer/solidgate/get-started/optimize-klarna-transactions/how-to-share-klarna-network-data/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"How to send Klarna Network Data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":10240},"klarna_originators":{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkOriginators"}}}},"components/schemas/RequestApmRecurringKlarnaNetwork":{"id":"components/schemas/RequestApmRecurringKlarnaNetwork","kind":"json-schema","title":"RequestApmRecurringKlarnaNetwork","data":{"title":"RequestApmRecurringKlarnaNetwork","type":"object","required":["payment_method","token","amount","currency","order_id","order_description","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/klarna/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["klarna-network"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandate token obtained from a previous Klarna transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Must match the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"billing_amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" authorized when the mandate was created."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Must match the currency authorized when the mandate was created. Klarna does not allow cross currency recurring charges."},"children":[]}]}]}],"enum":["AUD","CAD","CHF","CZK","DKK","EUR","GBP","HUF","MXN","NOK","NZD","PLN","RON","SEK","USD"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order description displayed to the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","minLength":6,"maxLength":100},"customer_first_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's first name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":99},"customer_last_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's last name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"physical_goods"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":99},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"payment_type_data":{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataKlarnaNetworkRecurring"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs in ranges 10.0.0.0 to 10.255.255.255, 172.16.0.0 to 172.31.255.255, and 192.168.0.0 to 192.168.255.255 will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringMbway":{"id":"components/schemas/RequestApmRecurringMbway","kind":"json-schema","title":"RequestApmRecurringMbway","data":{"title":"RequestApmRecurringMbway","type":"object","required":["amount","currency","order_id","order_description","customer_email","customer_phone","ip_address","platform","payment_method","token"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mb-way","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mbway"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For EUR currency, the amount should be in cents (e.g., 1020 = 10.20 EUR)."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringMercadopago":{"id":"components/schemas/RequestApmRecurringMercadopago","kind":"json-schema","title":"RequestApmRecurring","data":{"title":"RequestApmRecurring","type":"object","required":["payment_method","token","amount","currency","order_id","order_description","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mercado-pago","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mercadopago"]},"token":{"type":"string","description":"Secure payment token representing sensitive payment method information."},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL","CLP","COP","MXN"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringPix":{"id":"components/schemas/RequestApmRecurringPix","kind":"json-schema","title":"RequestApmRecurringSmartPix","data":{"title":"RequestApmRecurringSmartPix","type":"object","required":["order_id","token","amount","currency","order_description","customer_email","ip_address","platform","payment_method"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix payments via redirect to the customer’s bank page."},"children":[]}]}]}],"enum":["pix"]},"token":{"type":"string","description":"Secure payment token representing sensitive payment method information."},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringPixAutomatico":{"id":"components/schemas/RequestApmRecurringPixAutomatico","kind":"json-schema","title":"RequestApmRecurringPixAutomatico","data":{"title":"RequestApmRecurringPixAutomatico","type":"object","required":["order_id","token","amount","currency","order_description","customer_email","ip_address","platform","payment_method"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["pix-automatico"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandate or stored credential token from a completed Pix Automático init payment."},"children":[]}]}]}]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringUpi":{"id":"components/schemas/RequestApmRecurringUpi","kind":"json-schema","title":"RequestApmRecurringUpi","data":{"title":"RequestApmRecurringUpi","type":"object","required":["payment_method","token","amount","currency","order_id","order_description","customer_email","ip_address"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["upi"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize follow-up payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["INR"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringWechatpay":{"id":"components/schemas/RequestApmRecurringWechatpay","kind":"json-schema","title":"RequestApmRecurringWechatpay","data":{"title":"RequestApmRecurringWechatpay","type":"object","required":["amount","currency","order_id","order_description","customer_email","customer_phone","ip_address","payment_method","token"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["wechatpay"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For CNY currency, the amount should be in cents (e.g., 8900 = 89.00 CNY)."},"children":[]}]}]}],"minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"default":"CNY"},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The field value is displayed in the customer's WeChat Pay transaction history."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringDiscriminator":{"id":"components/schemas/RequestApmRecurringDiscriminator","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","discriminator":{"propertyName":"payment_method","mapping":{"paypal-vault":"#/components/schemas/RequestApmRecurringPaypal","alipay":"#/components/schemas/RequestApmRecurringAlipay","blik":"#/components/schemas/RequestApmRecurringBlik","gcash":"#/components/schemas/RequestApmRecurringGcash","klarna-network":"#/components/schemas/RequestApmRecurringKlarnaNetwork","mbway":"#/components/schemas/RequestApmRecurringMbway","mercadopago":"#/components/schemas/RequestApmRecurringMercadopago","pix":"#/components/schemas/RequestApmRecurringPix","pix-automatico":"#/components/schemas/RequestApmRecurringPixAutomatico","upi":"#/components/schemas/RequestApmRecurringUpi","wechatpay":"#/components/schemas/RequestApmRecurringWechatpay"}}}},"components/schemas/RequestApmRecurringOneTimeProductPaypal":{"id":"components/schemas/RequestApmRecurringOneTimeProductPaypal","kind":"json-schema","title":"RequestApmRecurringOneTimeProductPaypal","data":{"title":"RequestApmRecurringOneTimeProductPaypal","type":"object","required":["payment_method","token","product_id","order_id","order_description","customer_account_id","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["paypal-vault"]},"token":{"type":"string","description":"Secure payment token representing sensitive payment method information."},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringOneTimeProductAlipay":{"id":"components/schemas/RequestApmRecurringOneTimeProductAlipay","kind":"json-schema","title":"RequestApmRecurringOneTimeProductAlipay","data":{"title":"RequestApmRecurringOneTimeProductAlipay","type":"object","required":["payment_method","token","order_id","product_id","order_description","customer_account_id","customer_email","customer_phone","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["alipay"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"default":"CNY"},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client platform used to select the appropriate customer confirmation path during checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP opens authorization in an app context, MOB continues in mobile web, WEB runs a desktop browser flow."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringOneTimeProductBlik":{"id":"components/schemas/RequestApmRecurringOneTimeProductBlik","kind":"json-schema","title":"RequestApmRecurringOneTimeProductBlik","data":{"title":"RequestApmRecurringOneTimeProductBlik","type":"object","required":["payment_method","token","order_id","product_id","order_description","customer_account_id","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["blik"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringOneTimeProductGcash":{"id":"components/schemas/RequestApmRecurringOneTimeProductGcash","kind":"json-schema","title":"RequestApmRecurringOneTimeProductGcash","data":{"title":"RequestApmRecurringOneTimeProductGcash","type":"object","required":["payment_method","token","order_id","product_id","order_description","customer_account_id","customer_email","customer_first_name","customer_last_name","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["gcash"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"enum":["PHP"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringOneTimeProductMbway":{"id":"components/schemas/RequestApmRecurringOneTimeProductMbway","kind":"json-schema","title":"RequestApmRecurringOneTimeProductMbway","data":{"title":"RequestApmRecurringOneTimeProductMbway","type":"object","required":["payment_method","token","order_id","product_id","order_description","customer_account_id","customer_email","customer_phone","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mb-way","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mbway"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1-click"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringOneTimeProductMercadopago":{"id":"components/schemas/RequestApmRecurringOneTimeProductMercadopago","kind":"json-schema","title":"RequestApmRecurring","data":{"title":"RequestApmRecurring","type":"object","required":["payment_method","token","product_id","order_id","order_description","customer_account_id","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mercado-pago","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mercadopago"]},"token":{"type":"string","description":"Secure payment token representing sensitive payment method information."},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil or VAT/PAIS in Argentina."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL","CLP","COP","MXN"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringOneTimeProductPix":{"id":"components/schemas/RequestApmRecurringOneTimeProductPix","kind":"json-schema","title":"RequestApmSubscriptionRecurringSmartPix","data":{"title":"RequestApmSubscriptionRecurringSmartPix","type":"object","required":["order_id","product_id","token","order_description","customer_email","ip_address","platform","payment_method","customer_account_id"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix payments via redirect to the customer’s bank page."},"children":[]}]}]}],"enum":["pix"]},"token":{"type":"string","description":"Secure payment token representing sensitive payment method information."},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringOneTimeProductPixAutomatico":{"id":"components/schemas/RequestApmRecurringOneTimeProductPixAutomatico","kind":"json-schema","title":"RequestApmRecurringOneTimeProductPixAutomatico","data":{"title":"RequestApmRecurringOneTimeProductPixAutomatico","type":"object","required":["order_id","product_id","token","order_description","customer_email","ip_address","platform","payment_method","customer_account_id"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["pix-automatico"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandate or stored credential token from a completed Pix Automático init payment."},"children":[]}]}]}]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringOneTimeProductUpi":{"id":"components/schemas/RequestApmRecurringOneTimeProductUpi","kind":"json-schema","title":"RequestApmRecurringOneTimeProductUpi","data":{"title":"RequestApmRecurringOneTimeProductUpi","type":"object","required":["payment_method","token","product_id","order_id","customer_account_id","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["upi"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["INR"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringOneTimeProductWechatpay":{"id":"components/schemas/RequestApmRecurringOneTimeProductWechatpay","kind":"json-schema","title":"RequestApmRecurringOneTimeProductWechatpay","data":{"title":"RequestApmRecurringOneTimeProductWechatpay","type":"object","required":["payment_method","token","order_id","product_id","order_description","customer_account_id","customer_phone","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["wechatpay"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"default":"CNY"},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client platform used to determine how the payer authorization journey is started."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP starts authorization in an app context, MOB follows a mobile browser path, WEB uses a desktop browser path."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringOneTimeProductDiscriminator":{"id":"components/schemas/RequestApmRecurringOneTimeProductDiscriminator","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","type":"object","discriminator":{"propertyName":"payment_method","mapping":{"paypal-vault":"#/components/schemas/RequestApmRecurringOneTimeProductPaypal","alipay":"#/components/schemas/RequestApmRecurringOneTimeProductAlipay","blik":"#/components/schemas/RequestApmRecurringOneTimeProductBlik","gcash":"#/components/schemas/RequestApmRecurringOneTimeProductGcash","mbway":"#/components/schemas/RequestApmRecurringOneTimeProductMbway","mercadopago":"#/components/schemas/RequestApmRecurringOneTimeProductMercadopago","pix":"#/components/schemas/RequestApmRecurringOneTimeProductPix","pix-automatico":"#/components/schemas/RequestApmRecurringOneTimeProductPixAutomatico","upi":"#/components/schemas/RequestApmRecurringOneTimeProductUpi","wechatpay":"#/components/schemas/RequestApmRecurringOneTimeProductWechatpay"}}}},"components/schemas/RequestApmRecurringSubscriptionPaypal":{"id":"components/schemas/RequestApmRecurringSubscriptionPaypal","kind":"json-schema","title":"RequestApmRecurring","data":{"title":"RequestApmRecurring","type":"object","required":["payment_method","token","product_id","order_id","order_description","customer_account_id","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["paypal-vault"]},"token":{"type":"string","description":"Secure payment token representing sensitive payment method information."},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringSubscriptionAlipay":{"id":"components/schemas/RequestApmRecurringSubscriptionAlipay","kind":"json-schema","title":"RequestApmRecurring","data":{"title":"RequestApmRecurring","type":"object","required":["payment_method","token","order_id","product_id","order_description","customer_account_id","customer_phone","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["alipay"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"default":"CNY"},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client platform used to select the appropriate customer confirmation path during checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP opens authorization in an app context, MOB continues in mobile web, WEB runs a desktop browser flow."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringSubscriptionBlik":{"id":"components/schemas/RequestApmRecurringSubscriptionBlik","kind":"json-schema","title":"RequestApmRecurringSubscriptionBlik","data":{"title":"RequestApmRecurringSubscriptionBlik","type":"object","required":["payment_method","token","order_id","product_id","order_description","customer_account_id","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["blik"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["PLN"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringSubscriptionGcash":{"id":"components/schemas/RequestApmRecurringSubscriptionGcash","kind":"json-schema","title":"RequestApmRecurring","data":{"title":"RequestApmRecurring","type":"object","required":["payment_method","token","product_id","order_id","order_description","customer_account_id","customer_email","customer_first_name","customer_last_name","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["gcash"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"enum":["PHP"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringSubscriptionMbway":{"id":"components/schemas/RequestApmRecurringSubscriptionMbway","kind":"json-schema","title":"RequestApmRecurringSubscriptionMbway","data":{"title":"RequestApmRecurringSubscriptionMbway","type":"object","required":["payment_method","token","order_id","product_id","order_description","customer_account_id","customer_phone","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mb-way","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mbway"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["EUR"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringSubscriptionMercadopago":{"id":"components/schemas/RequestApmRecurringSubscriptionMercadopago","kind":"json-schema","title":"RequestApmRecurring","data":{"title":"RequestApmRecurring","type":"object","required":["payment_method","token","product_id","order_id","order_description","customer_account_id","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/mercado-pago","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["mercadopago"]},"token":{"type":"string","description":"Secure payment token representing sensitive payment method information."},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil or VAT/PAIS in Argentina."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL","CLP","COP","MXN"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringSubscriptionPix":{"id":"components/schemas/RequestApmRecurringSubscriptionPix","kind":"json-schema","title":"RequestApmSubscriptionRecurringSmartPix","data":{"title":"RequestApmSubscriptionRecurringSmartPix","type":"object","required":["order_id","product_id","token","order_description","customer_email","ip_address","platform","payment_method","customer_account_id"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix payments via redirect to the customer’s bank page."},"children":[]}]}]}],"enum":["pix"]},"token":{"type":"string","description":"Secure payment token representing sensitive payment method information."},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product identifier of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringSubscriptionPixAutomatico":{"id":"components/schemas/RequestApmRecurringSubscriptionPixAutomatico","kind":"json-schema","title":"RequestApmSubscriptionRecurringPixAutomatico","data":{"title":"RequestApmSubscriptionRecurringPixAutomatico","type":"object","required":["order_id","product_id","token","order_description","customer_email","ip_address","platform","payment_method","customer_account_id"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["pix-automatico"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandate or stored credential token from a completed Pix Automático subscription init payment."},"children":[]}]}]}]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product identifier of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Possible local "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"taxes"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", such as IOF-FX in Brazil."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["BRL"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringSubscriptionUpi":{"id":"components/schemas/RequestApmRecurringSubscriptionUpi","kind":"json-schema","title":"RequestApmRecurringSubscriptionUpi","data":{"title":"RequestApmRecurringSubscriptionUpi","type":"object","required":["payment_method","token","product_id","order_id","customer_account_id","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["upi"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize follow-up payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"enum":["INR"]},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","maxLength":50},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name.","maxLength":100},"customer_last_name":{"type":"string","description":"Customer's last name.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP for application, WEB for desktop web, MOB for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringSubscriptionWechatpay":{"id":"components/schemas/RequestApmRecurringSubscriptionWechatpay","kind":"json-schema","title":"RequestApmRecurring","data":{"title":"RequestApmRecurring","type":"object","required":["payment_method","token","order_id","product_id","order_description","customer_account_id","customer_phone","customer_email","ip_address","platform"],"properties":{"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"enum":["wechatpay"]},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token obtained from a previous transaction, used to authorize recurring payments without customer interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This token must be obtained from a previous successful initial transaction with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"future_usage"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"unscheduled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"default":"CNY"},"order_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brief order description."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sent to the customer."},"children":[]}]}]}],"maxLength":100},"order_date":{"type":"string","description":"Date of order creation defined by the merchant.","maxLength":18,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_date_of_birth":{"type":"string","description":"Customer's date of birth.","format":"date","maxLength":10},"customer_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in international format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://www.itu.int/rec/T-REC-E.164","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", starting with the plus "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"+"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sign."},"children":[]}]}]}],"maxLength":18,"pattern":"^\\+[1-9]\\d{1,14}$"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer language settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is used to translate the email receipt to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" languages. If no language is specified, the email receipt defaults to English."},"children":[]}]}]}],"default":"en"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client platform used to determine how the payer authorization journey is started."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP starts authorization in an app context, MOB follows a mobile browser path, WEB uses a desktop browser path."},"children":[]}]}]}],"enum":["APP","WEB","MOB"],"default":"WEB"},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fail_url":{"type":"string","description":"URL for browser redirect after a failed payment.","maxLength":255,"deprecated":true}}}},"components/schemas/RequestApmRecurringSubscriptionDiscriminator":{"id":"components/schemas/RequestApmRecurringSubscriptionDiscriminator","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","type":"object","discriminator":{"propertyName":"payment_method","mapping":{"paypal-vault":"#/components/schemas/RequestApmRecurringSubscriptionPaypal","alipay":"#/components/schemas/RequestApmRecurringSubscriptionAlipay","blik":"#/components/schemas/RequestApmRecurringSubscriptionBlik","gcash":"#/components/schemas/RequestApmRecurringSubscriptionGcash","mbway":"#/components/schemas/RequestApmRecurringSubscriptionMbway","mercadopago":"#/components/schemas/RequestApmRecurringSubscriptionMercadopago","pix":"#/components/schemas/RequestApmRecurringSubscriptionPix","pix-automatico":"#/components/schemas/RequestApmRecurringSubscriptionPixAutomatico","upi":"#/components/schemas/RequestApmRecurringSubscriptionUpi","wechatpay":"#/components/schemas/RequestApmRecurringSubscriptionWechatpay"}}}},"components/schemas/SchemaApmOrder":{"id":"components/schemas/SchemaApmOrder","kind":"json-schema","title":"SchemaApmOrder","data":{"title":"SchemaApmOrder","type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","required":["amount","currency","order_id","status","method","customer_email","ip_address","order_description","created_at","updated_at"],"properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"subscription_id":{"type":"string","description":"Unique subscription identifier.","format":"uuid","maxLength":36,"minLength":36},"token":{"type":"string","description":"Token associated with a payment method that can be used for the subsequent payments."},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"descriptor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying text that appears on a customer’s statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It includes information about the transaction and helps the customer recognize the charge and provided only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}],"example":"google.com"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","settle_pending","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"processing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of the payment in the smallest currency unit as it was processed by the payment service provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This amount may differ from the original order amount due to currency conversion or other processing factors."},"children":[]}]}]}],"deprecated":true},"processing_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the payment when it was processed by payment service provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In some cases, it is different from the original currency."},"children":[]}]}]}],"minLength":3,"maxLength":3,"deprecated":true}}}},"components/schemas/SchemaApmProviderData":{"id":"components/schemas/SchemaApmProviderData","kind":"json-schema","title":"SchemaApmProviderData","data":{"title":"SchemaApmProviderData","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data from the payment provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Parameters in this object are only available for transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}],"properties":{"billing_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardBillingAddress"}]},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/SchemaApmCardShippingAddress"}]},"payer":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted via "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides key information such as the payer's email, first name, and last name, crucial for identifying the payer in the transaction process."},"children":[]}]}]}],"type":"object","properties":{"account_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payer or their wallet identifier in the payment provider's system."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Used to uniquely identify the payer."},"children":[]}]}]}]},"first_name":{"type":"string","description":"Payer's first name, used to identify the individual within the transaction."},"last_name":{"type":"string","description":"Payer's last name, used to verify the payer's identity."},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number of the payer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Used for communication and identification purposes in the transaction."},"children":[]}]}]}]},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address of the payer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Used for communication and identification purposes in the transaction."},"children":[]}]}]}]}}},"merchant":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about the merchant involved in the transaction, useful for identifying the specific PayPal account used for the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This object provides identifiers for merchants, essential for accurate tracking and processing of transactions."},"children":[]}]}]}],"properties":{"account_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique merchant PayPal account identifier used in the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identifier is critical for associating the transaction with the correct merchant's PayPal account, enabling accurate processing and order reporting."},"children":[]}]}]}]}}}}}},"components/schemas/SchemaApmTransaction":{"id":"components/schemas/SchemaApmTransaction","kind":"json-schema","title":"SchemaApmTransaction","data":{"title":"SchemaApmTransaction","type":"object","required":["status","method","amount","currency","type","created_at"],"properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the transaction."},"children":[]}]}]}]},"id":{"type":"string","description":"Unique identifier associated with a transaction.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","settle_pending","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]},"refund_reason":{"type":"string","description":"Text description of the refund reason."},"refund_reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund reason "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/refund-reasons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is actively validated against the current list of reason codes. Deprecated codes will not be accepted."},"children":[]}]}]}],"minLength":4,"maxLength":4},"payer_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information such as the payer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","deprecated":true,"properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal.","example":"123443334","deprecated":true},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}],"deprecated":true}}}}}},"components/schemas/ResponseApmRecurring":{"id":"components/schemas/ResponseApmRecurring","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirmed recurring charge: updated order, transaction line items, and any provider-specific payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"transactions[].type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for token-based follow-up charges. Method-specific fields may appear under "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_type_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"order.provider_data"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" when the provider returns them."},"children":[]}]}]}],"properties":{"order":{"allOf":[{"$ref":"#/components/schemas/SchemaApmOrder"},{"type":"object","properties":{"provider_data":{"$ref":"#/components/schemas/SchemaApmProviderData"}}}]},"transactions":{"type":"array","description":"Details of a transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.","items":{"allOf":[{"$ref":"#/components/schemas/SchemaApmTransaction"}]}},"pay_form":{"allOf":[{"$ref":"#/components/schemas/SchemaApmPayForm"}]},"payment_type_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This object is specifically for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Boleto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix QR"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix Automático"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" initial mandate responses with QR payload and expiry."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponseBoleto"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponsePixQr"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponsePixAutomatico"}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmRecurringTokenCancellation":{"id":"components/schemas/RequestApmRecurringTokenCancellation","kind":"json-schema","title":"RequestApmRecurringTokenCancellation","data":{"title":"RequestApmRecurringTokenCancellation","type":"object","required":["token"],"properties":{"token":{"type":"string","description":"Recurring token to cancel.","example":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55"}}}},"components/schemas/ResponseApmRecurringTokenCancellation":{"id":"components/schemas/ResponseApmRecurringTokenCancellation","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Cancellation status.","enum":["processing"],"example":"processing"}}}},"components/schemas/SchemaApmErrorRevokeToken":{"id":"components/schemas/SchemaApmErrorRevokeToken","kind":"json-schema","title":"SchemaApmErrorRecurringTokenCancellation","data":{"title":"SchemaApmErrorRecurringTokenCancellation","type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" representing the specific error or status condition."},"children":[]}]}]}],"enum":["2.01"],"example":"2.01"},"messages":{"type":"object","description":"Object with string keys and array of strings as values.","additionalProperties":{"type":"array","items":{"type":"string"}},"example":{"general":["recurring token was not found"]}}},"required":["code","messages"]}},"components/schemas/SchemaApmError":{"id":"components/schemas/SchemaApmError","kind":"json-schema","title":"SchemaApmError","data":{"title":"SchemaApmError","type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" representing the specific error or status condition."},"children":[]}]}]}],"enum":["X.XX"],"example":"X.XX"},"messages":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array containing either strings or objects that provide details about the error or status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"When it is an array of strings, each string describes a separate issue. When it is an object, the object will contain key-value pairs explaining the issue in more detail."},"children":[]}]}]}],"items":{"oneOf":[{"type":"string"},{"type":"object"}]}},"recommended_message_for_user":{"type":"string","description":"Message with recommended next steps or additional information.","example":"Invalid card token."}},"required":["code","messages"]}},"components/schemas/SchemaApmDiscriminatorRevokeTokenError":{"id":"components/schemas/SchemaApmDiscriminatorRevokeTokenError","kind":"json-schema","title":"SchemaApmDiscriminatorRevokeTokenError","data":{"description":"Error object.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the declined payment."},"children":[]}]}]}]}},"discriminator":{"propertyName":"code","mapping":{"2.01":"#/components/schemas/SchemaApmErrorRevokeToken","X.XX":"#/components/schemas/SchemaApmError"}}}},"components/schemas/ResponseApmRecurringTokenCancellationError":{"id":"components/schemas/ResponseApmRecurringTokenCancellationError","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"error":{"$ref":"#/components/schemas/SchemaApmDiscriminatorRevokeTokenError"}},"required":["error"]}},"components/schemas/RequestApmRefund":{"id":"components/schemas/RequestApmRefund","kind":"json-schema","title":"RequestApmRefund","data":{"title":"RequestApmRefund","type":"object","properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}],"exclusiveMinimum":true,"minimum":0},"refund_reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund reason "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/refund-reasons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is actively validated against the current list of reason codes. Deprecated codes will not be accepted."},"children":[]}]}]}],"minLength":4,"maxLength":4}},"required":["order_id","amount"]}},"components/schemas/ResponseApmRefund":{"id":"components/schemas/ResponseApmRefund","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/SchemaApmOrder"},{"type":"object","properties":{"provider_data":{"$ref":"#/components/schemas/SchemaApmProviderData"}}}]},"transactions":{"type":"array","description":"Details of a transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.","items":{"allOf":[{"$ref":"#/components/schemas/SchemaApmTransaction"}]}},"pay_form":{"allOf":[{"$ref":"#/components/schemas/SchemaApmPayForm"}]},"payment_type_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This object is specifically for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Boleto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix QR"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix Automático"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" initial mandate responses with QR payload and expiry."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponseBoleto"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponsePixQr"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponsePixAutomatico"}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/RequestApmCheckOrderStatus":{"id":"components/schemas/RequestApmCheckOrderStatus","kind":"json-schema","title":"RequestApmCheckOrderStatus","data":{"title":"RequestApmCheckOrderStatus","type":"object","required":["order_id"],"properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255,"example":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55"}}}},"components/schemas/SchemaApmErrorInvalidCardToken":{"id":"components/schemas/SchemaApmErrorInvalidCardToken","kind":"json-schema","title":"SchemaMainErrorDoNotHonor","data":{"title":"SchemaMainErrorDoNotHonor","type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicating the reason for the payment decline."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"These errors often indicate that an invalid or nonexistent card token was received during the transaction."},"children":[]}]}]}],"enum":["5.02"],"example":"5.02"},"messages":{"type":"array","description":"Array containing messages that specify why the payment was declined due to validation errors.","items":{"type":"string","example":"Invalid card token"}},"recommended_message_for_user":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended message to be displayed to the user for further action or information."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Ask the customer to retry the transaction or use a different card. Ensure that the card token generation and handling processes are correctly implemented."},"children":[]}]}]}]}},"required":["code","messages"]}},"components/schemas/SchemaApmDiscriminatorErrorSuccess":{"id":"components/schemas/SchemaApmDiscriminatorErrorSuccess","kind":"json-schema","title":"SchemaApmDiscriminatorErrorSuccess","data":{"description":"Error object.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the declined payment."},"children":[]}]}]}]}},"discriminator":{"propertyName":"code","mapping":{"5.02 Invalid card token":"#/components/schemas/SchemaApmErrorInvalidCardToken","X.XX":"#/components/schemas/SchemaApmError"}}}},"components/schemas/ResponseApmCheckOrderStatus":{"id":"components/schemas/ResponseApmCheckOrderStatus","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/SchemaApmOrder"},{"type":"object","properties":{"provider_data":{"$ref":"#/components/schemas/SchemaApmProviderData"}}}]},"error":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Returned only in cases of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses at the order, and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"fail"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status at transaction."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/SchemaApmDiscriminatorErrorSuccess"}]},"transactions":{"type":"array","description":"Details of a transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.","items":{"allOf":[{"$ref":"#/components/schemas/SchemaApmTransaction"}]}},"pay_form":{"allOf":[{"$ref":"#/components/schemas/SchemaApmPayForm"}]},"payment_type_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data required to make payments with the specific "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/countries-specifics/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This object is specifically for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Boleto"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix QR"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pix Automático"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" initial mandate responses with QR payload and expiry."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponseBoleto"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponsePixQr"},{"$ref":"#/components/schemas/SchemaApmPaymentTypeDataResponsePixAutomatico"}]},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"components/schemas/SchemaApmDiscriminatorError":{"id":"components/schemas/SchemaApmDiscriminatorError","kind":"json-schema","title":"SchemaApmDiscriminatorError","data":{"description":"Error object.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the declined payment."},"children":[]}]}]}]}},"discriminator":{"propertyName":"code","mapping":{"2.01 Order not found":"#/components/schemas/SchemaMainErrorOrderNotFound","X.XX":"#/components/schemas/SchemaApmError"}}}},"components/schemas/ResponseApmError":{"id":"components/schemas/ResponseApmError","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"error":{"$ref":"#/components/schemas/SchemaApmDiscriminatorError"}},"required":["error"]}},"components/schemas/ResponseBillingProductCreateListOneTime":{"id":"components/schemas/ResponseBillingProductCreateListOneTime","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","type":"object","properties":{"data":{"type":"array","description":"Contains an array of product data, each representing a specific price configuration.","items":{"description":"Product data.","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"format":"uuid","example":"cb43b415-5522-4373-b026-a365462f9114"},"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a one-time purchase or a subscription product."},"children":[]}]}]}],"enum":["one-time"],"example":"one-time"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":"Product description for customers.","minLength":1,"maxLength":100,"example":"That cool product that you have bought"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"enum":["active","disabled","archived"],"example":"active"},"created_at":{"type":"string","description":"Datetime of the product creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the product has a trial, this field does not affect the first payments but influences recurring ones processed with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If there is no trial, this field defines the interval for the first "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" payment."},"children":[]}]}]}]}],"minimum":0,"maximum":168,"example":48},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}},"required":["id","name","type","description","status","created_at","updated_at","payment_action"]}},"pagination":{"type":"object","description":"Contains information about the pagination of the results.","properties":{"offset":{"type":"integer","description":"Starting index of the returned results.","example":20},"limit":{"type":"integer","description":"Maximum number of items to return.","example":10,"maximum":100},"total_count":{"type":"integer","description":"Total count of the products available.","example":150}},"required":["offset","limit","total_count"]}}}},"components/schemas/ResponseBillingProductCreateListSubscription":{"id":"components/schemas/ResponseBillingProductCreateListSubscription","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","type":"object","properties":{"data":{"type":"array","description":"Contains an array of product data, each representing a specific price configuration.","items":{"description":"Product data.","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"format":"uuid","example":"cb43b415-5522-4373-b026-a365462f9114"},"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a one-time purchase or a subscription product."},"children":[]}]}]}],"enum":["recurring"],"example":"recurring"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":"Product description for customers.","minLength":1,"maxLength":100,"example":"That cool product that you have bought"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"enum":["active","disabled","archived"],"example":"active"},"created_at":{"type":"string","description":"Datetime of the product creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"term_length":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of billing cycles before subscription expiration and automatic cancellation with error code "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8.08"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"example":20},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the product has a trial, this field does not affect the first payments but influences recurring ones processed with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If there is no trial, this field defines the interval for the first "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" payment."},"children":[]}]}]}]}],"minimum":0,"maximum":168,"example":48},"billing_period":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#billing-period","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in time units."},"children":[]}]}]}],"required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":"Value of the billing period as an integer.","minimum":1,"maximum":730,"example":10}}},"trial":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trial settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the trial type is free or paid. Must not be sent if the type is absent."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Once the product subscription is active, trial settings can be modified, but the trial itself cannot be added or removed."},"children":[]}]}]}],"required":["billing_period","payment_action"],"properties":{"billing_period":{"type":"object","description":"Trial billing period in time units.","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the trial billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":"Value of the trial billing period as an integer.","minimum":1,"maximum":730,"example":10}}},"payment_action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied to the first transaction, with or without the next money return, for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"free trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment actions are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_0_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_void"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the last indicating that the funds will be refunded to the customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account"},"children":[]}]}]}]}],"enum":["auth_0_amount","auth_void","auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if trial "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_action"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and must not be used for other "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_action"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" types."},"children":[]}]}]}],"minimum":0,"maximum":168,"example":48}}},"retry_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry mode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to recover the failed subscription payments."},"children":[]}]}]}],"enum":["smart","static"],"example":"static"},"retry_strategy_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"format":"uuid","example":"db43b415-5522-4373-b026-a365462f9439"},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}},"required":["id","name","type","description","status","created_at","updated_at","payment_action","billing_period"]}},"pagination":{"type":"object","description":"Contains information about the pagination of the results.","properties":{"offset":{"type":"integer","description":"Starting index of the returned results.","example":20},"limit":{"type":"integer","description":"Maximum number of items to return.","example":10,"maximum":100},"total_count":{"type":"integer","description":"Total count of the products available.","example":150}},"required":["offset","limit","total_count"]}}}},"components/schemas/ResponseBillingBadRequest":{"id":"components/schemas/ResponseBillingBadRequest","kind":"json-schema","title":"ResponseBillingBadRequest","data":{"type":"object","properties":{"error":{"required":["code","message"],"type":"object","description":"Error object.","properties":{"code":{"type":"string","description":"Error code.","example":"2.01"},"message":{"type":"string","description":"Error message.","example":"Validation error"},"constraints":{"type":"object","description":"Map of constraints.","additionalProperties":{"type":"array","description":"Dynamic map where keys represent the field names that failed validation, and values are arrays of objects detailing the constraint violations.","items":{"properties":{"code":{"type":"string","description":"Error code.","example":"NotNull"},"message":{"type":"string","description":"Error message.","example":"must not be null"}}}}}}}},"required":["error"]}},"components/schemas/ResponseBillingUnauthorized":{"id":"components/schemas/ResponseBillingUnauthorized","kind":"json-schema","title":"ResponseBillingUnauthorized","data":{"type":"object","properties":{"error":{"required":["code","message"],"type":"object","description":"Error object.","properties":{"code":{"type":"string","example":"1.01","description":"Error code indicating the specific authorization failure."},"message":{"type":"string","example":"Authorization failed","description":"Descriptive message providing more details about the authorization failure."}}}},"required":["error"]}},"components/schemas/ResponseMainAccessDenied":{"id":"components/schemas/ResponseMainAccessDenied","kind":"json-schema","title":"Access denied","data":{"title":"Access denied","type":"object","properties":{"error":{"type":"object","description":"Error object.","properties":{"code":{"type":"string","description":"Error code indicating that access to the service is denied.","example":"1.02"},"message":{"type":"string","description":"Message informing that the service is not allowed for the account.","example":"Access denied"}},"required":["code","message"]}},"required":["error"]}},"components/schemas/RequestBillingProductCreateOneTime":{"id":"components/schemas/RequestBillingProductCreateOneTime","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","description":"Product data.","type":"object","properties":{"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a one-time purchase or a subscription product."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Once a product is created, its type cannot be changed."},"children":[]}]}]}],"enum":["one-time"],"default":"recurring","example":"one-time"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product description for customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide as it is sent to banks, shown in customer bank statements, and included in Solidgate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipts"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", helping customers identify who charged them and for what."},"children":[]}]}]}],"minLength":1,"maxLength":100,"example":"That cool product which you have bought"},"status":{"type":"string","description":"Product status.","enum":["disabled","active"],"example":"active"},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minimum":0,"maximum":168,"example":48},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}},"required":["name","description","status","payment_action"]}},"components/schemas/RequestBillingProductCreateSubscription":{"id":"components/schemas/RequestBillingProductCreateSubscription","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","description":"Product data.","type":"object","properties":{"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a one-time purchase or a subscription product."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Once a product is created, its type cannot be changed."},"children":[]}]}]}],"enum":["recurring"],"default":"recurring","example":"recurring"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product description for customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide as it is sent to banks, shown in customer bank statements, and included in Solidgate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipts"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", helping customers identify who charged them and for what."},"children":[]}]}]}],"minLength":1,"maxLength":100,"example":"That cool product which you have bought"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"enum":["disabled","active"],"example":"active"},"term_length":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of billing cycles before subscription expiration and automatic cancellation with error code "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8.08"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"example":20},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the product has a trial, this field does not affect the first payments but influences recurring ones processed with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If there is no trial, this field defines the interval for the first "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" payment."},"children":[]}]}]}]}],"minimum":0,"maximum":168,"example":48},"billing_period":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#billing-period","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in time units, with a maximum value equivalent to 2 years."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the billing period as an integer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum value must not exceed 730 days, 104 weeks, 24 months, or 2 years."},"children":[]}]}]}],"minimum":1,"maximum":730,"example":10}}},"trial":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trial period settings, applicable for products offering free or paid trials."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Once the product subscription is active, trial settings can be modified, but the trial itself cannot be added or removed."},"children":[]}]}]}],"required":["billing_period","payment_action"],"properties":{"billing_period":{"type":"object","description":"Trial billing period in time units, with a maximum value equivalent to 2 years.","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the trial billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the trial billing period as an integer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum value must not exceed 730 days, 104 weeks, 24 months, or 2 years."},"children":[]}]}]}],"minimum":1,"maximum":730,"example":10}}},"payment_action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied to the first transaction, with or without the next money return, for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"free trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment actions are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_0_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_void"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the last indicating that the funds will be refunded to the customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account"},"children":[]}]}]}]}],"enum":["auth_0_amount","auth_void","auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if trial "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_action"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and must not be used for other "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_action"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" types."},"children":[]}]}]}],"minimum":0,"maximum":168,"example":48}}},"retry_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry mode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to recover the failed subscription payments."},"children":[]}]}]}],"enum":["smart","static"],"example":"static"},"retry_strategy_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pass it for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"static"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" retry mode."},"children":[]}]}]}],"format":"uuid","example":"db43b415-5522-4373-b026-a365462f9439"},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}},"required":["name","description","status","billing_period","payment_action"]}},"components/schemas/ResponseBillingProductCreateOneTime":{"id":"components/schemas/ResponseBillingProductCreateOneTime","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","description":"Product data.","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"ac43b415-5522-4373-b026-a365462f9657"},"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a one-time purchase or a subscription product."},"children":[]}]}]}],"enum":["one-time"],"example":"one-time"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":"Product description for customers.","minLength":1,"maxLength":100,"example":"That cool product that you have bought"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"enum":["disabled","active"],"example":"active"},"created_at":{"type":"string","description":"Datetime of the product creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the product has a trial, this field does not affect the first payments but influences recurring ones processed with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If there is no trial, this field defines the interval for the first "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" payment."},"children":[]}]}]}]}],"minimum":0,"maximum":168,"example":48},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}},"required":["id","name","type","description","status","created_at","updated_at","payment_action"]}},"components/schemas/ResponseBillingProductCreateSubscription":{"id":"components/schemas/ResponseBillingProductCreateSubscription","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","description":"Product data.","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"ac43b415-5522-4373-b026-a365462f9657"},"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a one-time purchase or a subscription product."},"children":[]}]}]}],"enum":["recurring"],"example":"recurring"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":"Product description for customers.","minLength":1,"maxLength":100,"example":"That cool product that you have bought"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"enum":["disabled","active"],"example":"active"},"created_at":{"type":"string","description":"Datetime of the product creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"term_length":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of billing cycles before subscription expiration and automatic cancellation with error code "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8.08"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"example":20},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the product has a trial, this field does not affect the first payments but influences recurring ones processed with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If there is no trial, this field defines the interval for the first "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" payment."},"children":[]}]}]}]}],"minimum":0,"maximum":168,"example":48},"billing_period":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#billing-period","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in time units."},"children":[]}]}]}],"required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":"Value of the billing period as an integer.","minimum":1,"maximum":730,"example":10}}},"trial":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trial settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the trial type is free or paid. Must not be sent if the type is absent."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Once the product subscription is active, trial settings can be modified, but the trial itself cannot be added or removed."},"children":[]}]}]}],"required":["billing_period","payment_action"],"properties":{"billing_period":{"type":"object","description":"Trial billing period in time units.","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the trial billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":"Value of the trial billing period as an integer.","minimum":1,"maximum":730,"example":10}}},"payment_action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied to the first transaction, with or without the next money return, for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"free trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment actions are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_0_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_void"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the last indicating that the funds will be refunded to the customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account"},"children":[]}]}]}]}],"enum":["auth_0_amount","auth_void","auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if trial "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_action"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and must not be used for other "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_action"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" types."},"children":[]}]}]}],"minimum":0,"maximum":168,"example":48}}},"retry_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry mode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to recover the failed subscription payments."},"children":[]}]}]}],"enum":["smart","static"],"example":"static"},"retry_strategy_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"format":"uuid","example":"db43b415-5522-4373-b026-a365462f9439"},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}},"required":["id","name","type","description","status","created_at","updated_at","payment_action","billing_period"]}},"components/schemas/ResponseBillingUnprocessableEntityError":{"id":"components/schemas/ResponseBillingUnprocessableEntityError","kind":"json-schema","title":"ResponseBillingUnprocessableEntityError","data":{"type":"object","properties":{"error":{"required":["code","message"],"type":"object","description":"Error object.","properties":{"code":{"type":"string","description":"Error code indicating that while the request is well-formed, it cannot be processed due to conflicting or incorrect data.","example":"2.01"},"message":{"type":"string","description":"Descriptive message providing more details about the processing failure.","example":"Unprocessable entity"}}}},"required":["error"]}},"components/schemas/ResponseBillingProductGetByIdOneTime":{"id":"components/schemas/ResponseBillingProductGetByIdOneTime","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","description":"Product data.","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"ac43b415-5522-4373-b026-a365462f9657"},"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a one-time purchase or a subscription product."},"children":[]}]}]}],"enum":["one-time"],"example":"one-time"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":"Product description for customers.","minLength":1,"maxLength":100,"example":"That cool product that you have bought"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"enum":["active","disabled","archived"],"example":"active"},"created_at":{"type":"string","description":"Datetime of the product creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the product has a trial, this field does not affect the first payments but influences recurring ones processed with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If there is no trial, this field defines the interval for the first "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" payment."},"children":[]}]}]}]}],"minimum":0,"maximum":168,"example":48},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}},"required":["id","name","type","description","status","created_at","updated_at","payment_action"]}},"components/schemas/ResponseBillingProductGetByIdSubscription":{"id":"components/schemas/ResponseBillingProductGetByIdSubscription","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","description":"Product data.","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"ac43b415-5522-4373-b026-a365462f9657"},"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a one-time purchase or a subscription product."},"children":[]}]}]}],"enum":["recurring"],"example":"recurring"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":"Product description for customers.","minLength":1,"maxLength":100,"example":"That cool product that you have bought"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"enum":["active","disabled","archived"],"example":"active"},"created_at":{"type":"string","description":"Datetime of the product creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"term_length":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of billing cycles before subscription expiration and automatic cancellation with error code "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8.08"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"example":20},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the product has a trial, this field does not affect the first payments but influences recurring ones processed with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If there is no trial, this field defines the interval for the first "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" payment."},"children":[]}]}]}]}],"minimum":0,"maximum":168,"example":48},"billing_period":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#billing-period","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in time units."},"children":[]}]}]}],"required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":"Value of the billing period as an integer.","minimum":1,"maximum":730,"example":10}}},"trial":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trial settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the trial type is free or paid. Must not be sent if the type is absent."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Once the product subscription is active, trial settings can be modified, but the trial itself cannot be added or removed."},"children":[]}]}]}],"required":["billing_period","payment_action"],"properties":{"billing_period":{"type":"object","description":"Trial billing period in time units.","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the trial billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":"Value of the trial billing period as an integer.","minimum":1,"maximum":730,"example":10}}},"payment_action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied to the first transaction, with or without the next money return, for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"free trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment actions are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_0_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_void"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the last indicating that the funds will be refunded to the customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account"},"children":[]}]}]}]}],"enum":["auth_0_amount","auth_void","auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if trial "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_action"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and must not be used for other "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_action"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" types."},"children":[]}]}]}],"minimum":0,"maximum":168,"example":48}}},"retry_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry mode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to recover the failed subscription payments."},"children":[]}]}]}],"enum":["smart","static"],"example":"static"},"retry_strategy_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"format":"uuid","example":"db43b415-5522-4373-b026-a365462f9439"},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}},"required":["id","name","type","description","status","created_at","updated_at","payment_action","billing_period"]}},"components/schemas/ResponseBillingEntityNotFound":{"id":"components/schemas/ResponseBillingEntityNotFound","kind":"json-schema","title":"Entity not found","data":{"title":"Entity not found","type":"object","properties":{"error":{"type":"object","description":"Error object.","properties":{"code":{"type":"string","description":"Error code.","example":"2.01"},"message":{"type":"string","description":"Error message.","example":"{entityName} not found with id: {entityId}"}},"required":["code","message"]}},"required":["error"]}},"components/schemas/RequestBillingProductUpdateOneTime":{"id":"components/schemas/RequestBillingProductUpdateOneTime","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","description":"Product data.","type":"object","properties":{"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product description for customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide as it is sent to banks, shown in customer bank statements, and included in Solidgate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipts"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", helping customers identify who charged them and for what."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"To remove the existing public description, send "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":100,"example":"That cool product which you have bought"},"status":{"type":"string","description":"Product status.","enum":["disabled","active"],"example":"active"},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to check validation for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minimum":0,"maximum":168,"example":48},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"To remove all existing metadata, send "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}}}},"components/schemas/RequestBillingProductUpdateSubscription":{"id":"components/schemas/RequestBillingProductUpdateSubscription","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","description":"Product data.","type":"object","properties":{"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product description for customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2E7C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Highly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to provide as it is sent to banks, shown in customer bank statements, and included in Solidgate "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/email-receipts/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"email receipts"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", helping customers identify who charged them and for what."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"To remove the existing public description, send "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":100,"example":"That cool product which you have bought"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"enum":["disabled","active"],"example":"active"},"term_length":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of billing cycles before subscription expiration and automatic cancellation with error code "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8.08"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"example":20},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the product has a trial, this field does not affect the first payments but influences recurring ones processed with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If there is no trial, this field defines the interval for the first "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" payment."},"children":[]}]}]}]}],"minimum":0,"maximum":168,"example":48},"billing_period":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#billing-period","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in time units, with a maximum value equivalent to 2 years."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the billing period as an integer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum value must not exceed 730 days, 104 weeks, 24 months, or 2 years."},"children":[]}]}]}],"minimum":1,"maximum":730,"example":10}}},"trial":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trial period settings, applicable for products offering free or paid trials."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Once the product subscription is active, trial settings can be modified, but the trial itself cannot be added or removed."},"children":[]}]}]}],"required":["billing_period","payment_action"],"properties":{"billing_period":{"type":"object","description":"Trial billing period in time units, with a maximum value equivalent to 2 years.","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the trial billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the trial billing period as an integer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Maximum value must not exceed 730 days, 104 weeks, 24 months, or 2 years."},"children":[]}]}]}],"minimum":1,"maximum":730,"example":10}}},"payment_action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied to the first transaction, with or without the next money return, for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"free trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment actions are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_0_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_void"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the last indicating that the funds will be refunded to the customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account"},"children":[]}]}]}]}],"enum":["auth_0_amount","auth_void","auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if trial "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_action"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and must not be used for other "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_action"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" types."},"children":[]}]}]}],"minimum":0,"maximum":168,"example":48}}},"retry_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry mode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to recover the failed subscription payments."},"children":[]}]}]}],"enum":["smart","static"],"example":"static"},"retry_strategy_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pass it for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"static"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" retry mode."},"children":[]}]}]}],"format":"uuid","example":"db43b415-5522-4373-b026-a365462f9439"},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"To remove all existing metadata, send "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}}}},"components/schemas/ResponseBillingProductUpdateOneTime":{"id":"components/schemas/ResponseBillingProductUpdateOneTime","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","description":"Product data.","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for one-time purchases, such as upsells or single-use services."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"ac43b415-5522-4373-b026-a365462f9657"},"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a one-time purchase or a subscription product."},"children":[]}]}]}],"enum":["one-time"],"example":"one-time"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":"Product description for customers.","minLength":1,"maxLength":100,"example":"That cool product that you have bought"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"enum":["disabled","active"],"example":"active"},"created_at":{"type":"string","description":"Datetime of the product creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the product has a trial, this field does not affect the first payments but influences recurring ones processed with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If there is no trial, this field defines the interval for the first "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" payment."},"children":[]}]}]}]}],"minimum":0,"maximum":168,"example":48},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}},"required":["id","name","type","description","status","created_at","updated_at","payment_action"]}},"components/schemas/ResponseBillingProductUpdateSubscription":{"id":"components/schemas/ResponseBillingProductUpdateSubscription","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","description":"Product data.","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" used for recurring purchases, such as services with ongoing access or a subscription-based model."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"ac43b415-5522-4373-b026-a365462f9657"},"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a one-time purchase or a subscription product."},"children":[]}]}]}],"enum":["recurring"],"example":"recurring"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":"Product description for customers.","minLength":1,"maxLength":100,"example":"That cool product that you have bought"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"enum":["disabled","active"],"example":"active"},"created_at":{"type":"string","description":"Datetime of the product creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"term_length":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of billing cycles before subscription expiration and automatic cancellation with error code "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8.08"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"example":20},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the product has a trial, this field does not affect the first payments but influences recurring ones processed with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If there is no trial, this field defines the interval for the first "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" payment."},"children":[]}]}]}]}],"minimum":0,"maximum":168,"example":48},"billing_period":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#billing-period","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in time units."},"children":[]}]}]}],"required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":"Value of the billing period as an integer.","minimum":1,"maximum":730,"example":10}}},"trial":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trial settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the trial type is free or paid. Must not be sent if the type is absent."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Once the product subscription is active, trial settings can be modified, but the trial itself cannot be added or removed."},"children":[]}]}]}],"required":["billing_period","payment_action"],"properties":{"billing_period":{"type":"object","description":"Trial billing period in time units.","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the trial billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":"Value of the trial billing period as an integer.","minimum":1,"maximum":730,"example":10}}},"payment_action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied to the first transaction, with or without the next money return, for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"free trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment actions are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_0_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_void"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the last indicating that the funds will be refunded to the customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account"},"children":[]}]}]}]}],"enum":["auth_0_amount","auth_void","auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if trial "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_action"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_settle"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and must not be used for other "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_action"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" types."},"children":[]}]}]}],"minimum":0,"maximum":168,"example":48}}},"retry_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry mode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to recover the failed subscription payments."},"children":[]}]}]}],"enum":["smart","static"],"example":"static"},"retry_strategy_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"format":"uuid","example":"db43b415-5522-4373-b026-a365462f9439"},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}},"required":["id","name","type","description","status","created_at","updated_at","payment_action","billing_period"]}},"components/schemas/ResponseBillingProductArchiveOneTime":{"id":"components/schemas/ResponseBillingProductArchiveOneTime","kind":"json-schema","title":"Product-based payment","data":{"title":"Product-based payment","description":"Product data.","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"ac43b415-5522-4373-b026-a365462f9657"},"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a one-time purchase or a subscription product."},"children":[]}]}]}],"enum":["one-time"],"example":"one-time"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":"Product description for customers.","minLength":1,"maxLength":100,"example":"That cool product that you have bought"},"status":{"type":"string","description":"Product status.","enum":["archived"],"example":"archived"},"created_at":{"type":"string","description":"Datetime of the product creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]}],"minimum":0,"maximum":168,"example":48},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}},"required":["id","name","type","description","status","created_at","updated_at","payment_action"]}},"components/schemas/ResponseBillingProductArchiveSubscription":{"id":"components/schemas/ResponseBillingProductArchiveSubscription","kind":"json-schema","title":"Subscription payment","data":{"title":"Subscription payment","description":"Product data.","type":"object","properties":{"id":{"type":"string","description":"Unique product identifier.","format":"uuid","maxLength":36,"minLength":36,"example":"ac43b415-5522-4373-b026-a365462f9657"},"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":500,"example":"Luxury product"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a one-time purchase or a subscription product."},"children":[]}]}]}],"enum":["recurring"],"example":"recurring"},"description":{"type":"string","description":"Product description.","minLength":1,"maxLength":500,"example":"This product is the best product all over the world"},"public_description":{"type":"string","description":"Product description for customers.","minLength":1,"maxLength":100,"example":"That cool product that you have bought"},"status":{"type":"string","description":"Product status.","enum":["archived"],"example":"archived"},"created_at":{"type":"string","description":"Datetime of the product creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"term_length":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of billing cycles before subscription expiration and automatic cancellation with error code "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8.08"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":20},"payment_action":{"type":"string","description":"Payment processing flow applied to the transaction.","enum":["auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours."},"children":[]}]}]}],"minimum":0,"maximum":168,"example":48},"billing_period":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#billing-period","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in time units."},"children":[]}]}]}],"required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":"Value of the billing period as an integer.","minimum":1,"maximum":730,"example":10}}},"trial":{"type":"object","description":"Trial settings.","required":["billing_period","payment_action"],"properties":{"billing_period":{"type":"object","description":"Trial billing period in time units.","required":["unit","value"],"properties":{"unit":{"type":"string","description":"Unit of the trial billing period.","enum":["day","week","month","year"],"example":"day"},"value":{"type":"integer","description":"Value of the trial billing period as an integer.","minimum":1,"maximum":730,"example":10}}},"payment_action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied to the first transaction, with or without the next money return, for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"free trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment actions are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_0_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_void"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the last indicating that the funds will be refunded to the customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account"},"children":[]}]}]}]}],"enum":["auth_0_amount","auth_void","auth_settle"],"example":"auth_settle"},"settle_interval":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before automatic transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in hours used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment flow."},"children":[]}]}]}],"minimum":0,"maximum":168,"example":48}}},"retry_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry mode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to recover the failed subscription payments."},"children":[]}]}]}],"enum":["smart","static"],"example":"static"},"retry_strategy_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"format":"uuid","example":"db43b415-5522-4373-b026-a365462f9439"},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains product "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"required":["category_id"],"properties":{"category_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tax "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":1,"maxLength":50,"example":"taxc_01JJVD231C879QBHVTVCWJ1K2A"},"behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how taxes are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to product prices and shown to customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"included"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"excluded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" tax behavior takes priority over tax rules configured for locations."},"children":[]}]}]}],"enum":["location_preset","included","excluded"],"example":"included"}}},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Supports up to 50 key-value pairs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Keys can be up to 40 characters (letters, digits, hyphens, and underscores)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Values can be up to 500 characters"},"children":[]}]}]}]}],"additionalProperties":{"type":"string","maxLength":500},"maxProperties":50,"example":{"access_duration":"30d","plan_tier":"premium"}}},"required":["id","name","type","description","status","created_at","updated_at","payment_action","billing_period"]}},"components/schemas/SchemaBillingPriceData":{"id":"components/schemas/SchemaBillingPriceData","kind":"json-schema","title":"SchemaBillingPriceData","data":{"description":"Contains price data items, each representing a specific price configuration.","required":["id","default","status","created_at","updated_at","product_price","currency"],"type":"object","properties":{"id":{"type":"string","description":"Unique product price identifier.","format":"uuid","example":"cb43b415-5522-4373-b026-a365462f9114"},"default":{"type":"boolean","description":"Indicates whether the price is the default for the product.","example":false},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product price status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cannot be changed if a subscription exists for the product."},"children":[]}]}]}],"enum":["active","disabled","archived"],"example":"active"},"created_at":{"type":"string","description":"Datetime of the product price creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product price update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"product_price":{"type":"integer","description":"Product price.","minimum":1,"maximum":999999999,"example":1000},"trial_price":{"type":"integer","description":"Trial price.","minimum":1,"maximum":999999999,"example":500},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the product price currency."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Not returned or expected for default prices."},"children":[]}]}]}],"format":"iso_code_a3","example":"USA","maxLength":3,"minLength":3}}}},"components/schemas/ResponseBillingProductPriceCreateList":{"id":"components/schemas/ResponseBillingProductPriceCreateList","kind":"json-schema","title":"ResponseBillingProductPriceCreateList","data":{"type":"object","properties":{"data":{"type":"array","description":"Contains price data items, each representing a specific price configuration.","items":{"$ref":"#/components/schemas/SchemaBillingPriceData"}},"pagination":{"type":"object","description":"Contains information about the pagination of the results.","required":["offset","limit","total_count"],"properties":{"offset":{"type":"integer","description":"Starting index of the returned results.","example":20},"limit":{"type":"integer","description":"Maximum number of items to return.","example":10,"maximum":100},"total_count":{"type":"integer","description":"Total count of the products available.","example":150}}}}}},"components/schemas/RequestBillingProductPriceCreate":{"id":"components/schemas/RequestBillingProductPriceCreate","kind":"json-schema","title":"RequestBillingProductPriceCreate","data":{"description":"Data for creating product price.","properties":{"default":{"type":"boolean","description":"Indicates whether the price is the default for the product.","example":false},"status":{"type":"string","description":"Product price status.","enum":["disabled","active"],"example":"active"},"product_price":{"type":"integer","description":"Product price.","minimum":1,"maximum":999999999,"example":1000},"trial_price":{"type":"integer","description":"Trial price.","minimum":1,"maximum":999999999,"example":500},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the product price currency."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Not returned or expected for default prices."},"children":[]}]}]}],"format":"iso_code_a3","example":"USA","maxLength":3,"minLength":3}},"required":["status","product_price","currency","default"]}},"components/schemas/ResponseBillingProductPriceCreate":{"id":"components/schemas/ResponseBillingProductPriceCreate","kind":"json-schema","title":"ResponseBillingProductPriceCreate","data":{"description":"Data for creating product price.","type":"object","properties":{"id":{"type":"string","description":"Unique product price identifier.","format":"uuid","example":"cb43b415-5522-4373-b026-a365462f9114"},"default":{"type":"boolean","description":"Indicates whether the price is the default for the product.","example":false},"status":{"type":"string","description":"Product price status.","enum":["disabled","active"],"example":"active"},"created_at":{"type":"string","description":"Datetime of the product price creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product price update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"product_price":{"type":"integer","description":"Product price.","minimum":1,"maximum":999999999,"example":1000},"trial_price":{"type":"integer","description":"Trial price.","minimum":1,"maximum":999999999,"example":500},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the product price currency."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Not returned or expected for default prices."},"children":[]}]}]}],"format":"iso_code_a3","example":"USA","maxLength":3,"minLength":3}},"required":["id","default","status","created_at","updated_at","product_price","currency"]}},"components/schemas/RequestBillingRetrievePrices":{"id":"components/schemas/RequestBillingRetrievePrices","kind":"json-schema","title":"RequestBillingRetrievePrices","data":{"type":"object","properties":{"filters":{"type":"object","description":"Filter criteria for retrieving prices.","properties":{"default":{"type":"object","description":"Specify if to retrieve default prices.","properties":{"operator":{"type":"string","enum":["eq"],"description":"Specify operator for filtering default prices.","example":"eq"},"value":{"type":"string","description":"Set to true to retrieve default prices.","enum":["true","false"],"example":"true"}}},"updated_at":{"type":"object","description":"Filter by update timestamp for incremental synchronization.","properties":{"operator":{"type":"string","enum":["gte"],"description":"Comparison operator for the timestamp.","example":"gte"},"value":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Timestamp to filter prices.","example":"2025-12-15 10:40:25"}}}}},"pagination":{"type":"object","description":"Pagination settings for retrieving prices.","properties":{"page_size":{"type":"integer","description":"Page size based on the set or default value.","minimum":1,"maximum":100,"default":10,"example":100},"next_page_token":{"type":"string","description":"Token for retrieving the next page of results. Obtained from the previous response. Omit this parameter for the first request.","minLength":1,"example":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9"}}}}}},"components/schemas/ResponseBillingRetrievePrices":{"id":"components/schemas/ResponseBillingRetrievePrices","kind":"json-schema","title":"ResponseBillingRetrievePrices","data":{"type":"object","properties":{"items":{"type":"array","description":"Contains price data items, each representing a specific price configuration.","items":{"$ref":"#/components/schemas/SchemaBillingPriceData"}},"pagination":{"type":"object","description":"Contains information about the pagination of the results.","required":["page_size"],"properties":{"page_size":{"type":"integer","description":"Page size based on the set or default value.","example":100},"next_page_token":{"type":"string","description":"Token to retrieve the next page of results. Use this value in the next request. Empty or null if no more pages are available.","example":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9"}}}}}},"components/schemas/RequestBillingProductPriceUpdate":{"id":"components/schemas/RequestBillingProductPriceUpdate","kind":"json-schema","title":"RequestBillingProductPriceUpdate","data":{"type":"object","description":"Data for updating product price.","properties":{"status":{"type":"string","description":"Product price status.","enum":["disabled","active"],"example":"active"},"product_price":{"type":"integer","description":"Product price.","minimum":1,"maximum":999999999,"example":1000},"trial_price":{"type":"integer","description":"Trial price.","minimum":1,"maximum":999999999,"example":500},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the product price currency."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Not returned or expected for default prices."},"children":[]}]}]}],"format":"iso_code_a3","example":"USA","maxLength":3,"minLength":3},"default":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotes the price to the product's default price. The previous default price remains active but is no longer the default. Archive it separately if it should no longer be available."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Only an active price without a country can become the default. You can combine "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"default"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_price"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"trial_price"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" in the same request. These values are applied after the price becomes the default. Because a default price cannot have a country or a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"disabled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status, combining "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"default"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with either fails."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the price has associated subscriptions, you cannot combine "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"default"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_price"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"trial_price"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". The same restriction applies when updating those fields directly. Promoting a price to the default without changing any other fields is always allowed."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Setting "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"default"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" on the current default price fails. To remove the current default, promote another price to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"default"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" instead."},"children":[]}]}]}],"example":true}}}},"components/schemas/ResponseBillingProductPriceUpdate":{"id":"components/schemas/ResponseBillingProductPriceUpdate","kind":"json-schema","title":"ResponseBillingProductPriceUpdate","data":{"description":"Data for creating product price.","type":"object","properties":{"id":{"type":"string","description":"Unique product price identifier.","format":"uuid","example":"cb43b415-5522-4373-b026-a365462f9114"},"default":{"type":"boolean","description":"Indicates whether the price is the default for the product.","example":false},"status":{"type":"string","description":"Product price status.","enum":["disabled","active"],"example":"active"},"created_at":{"type":"string","description":"Datetime of the product price creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product price update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"product_price":{"type":"integer","description":"Product price.","minimum":1,"maximum":999999999,"example":1000},"trial_price":{"type":"integer","description":"Trial price.","minimum":1,"maximum":999999999,"example":500},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the product price currency."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Not returned or expected for default prices."},"children":[]}]}]}],"format":"iso_code_a3","example":"USA","maxLength":3,"minLength":3}},"required":["id","default","status","created_at","updated_at","product_price","currency"]}},"components/schemas/ResponseBillingProductPriceArchive":{"id":"components/schemas/ResponseBillingProductPriceArchive","kind":"json-schema","title":"ResponseBillingProductPriceArchive","data":{"description":"Product price data.","type":"object","properties":{"id":{"type":"string","description":"Unique product price identifier.","format":"uuid","example":"cb43b415-5522-4373-b026-a365462f9114"},"default":{"type":"boolean","description":"Indicates whether the price is the default for the product.","example":false},"status":{"type":"string","description":"Product price status.","enum":["archived"],"example":"archived"},"created_at":{"type":"string","description":"Datetime of the product price creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"updated_at":{"type":"string","description":"Datetime of the product price update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:13"},"product_price":{"type":"integer","description":"Product price.","minimum":1,"maximum":999999999,"example":1000},"trial_price":{"type":"integer","description":"Trial price.","minimum":1,"maximum":999999999,"example":500},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the product price currency."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Not returned or expected for default prices."},"children":[]}]}]}],"format":"iso_code_a3","example":"USA","maxLength":3,"minLength":3}},"required":["id","default","status","created_at","updated_at","product_price","currency"]}},"components/schemas/ResponseBillingReportTaxTransactional":{"id":"components/schemas/ResponseBillingReportTaxTransactional","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"report_url":{"type":"string","description":"URL for the report stored on Amazon S3, which needs to be downloaded.","example":"https://reports.solidgate.com/api/v1/tax/transactional/report/tax_transactional_250702_140728/download"}}}},"components/schemas/ResponseBillingReportTaxSummary":{"id":"components/schemas/ResponseBillingReportTaxSummary","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"report_url":{"type":"string","description":"URL for the report stored on Amazon S3, which needs to be downloaded.","example":"https://reports.solidgate.com/api/v1/tax/summary/report/tax_summary_250702_140728/download"}}}},"components/schemas/SchemaBillingProductPriceCalculateCountry":{"id":"components/schemas/SchemaBillingProductPriceCalculateCountry","kind":"json-schema","title":"country","data":{"title":"country","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code."},"children":[]}]}]}],"format":"iso_code_a3","maxLength":3,"minLength":3,"example":"USA"}},"required":["country"]}},"components/schemas/SchemaBillingProductPriceCalculateIP":{"id":"components/schemas/SchemaBillingProductPriceCalculateIP","kind":"json-schema","title":"ip_address","data":{"title":"ip_address","properties":{"ip_address":{"type":"string","description":"Public IP address of the cardholder, both IPv4 and IPv6 are supported.","format":"ip","maxLength":50,"example":"127.0.0.1"}},"required":["ip_address"]}},"components/schemas/RequestBillingProductPriceCalculate":{"id":"components/schemas/RequestBillingProductPriceCalculate","kind":"json-schema","title":"RequestSubscriptionsProductPriceCalculate","data":{"title":"RequestSubscriptionsProductPriceCalculate","type":"object","properties":{"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the product price currency."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"location":{"type":"object","description":"Information about the cardholder's location, specified as either a country code or an IP address.","oneOf":[{"$ref":"#/components/schemas/SchemaBillingProductPriceCalculateCountry"},{"$ref":"#/components/schemas/SchemaBillingProductPriceCalculateIP"}]}},"required":["product_id","location"]}},"components/schemas/ResponseBillingProductPriceCalculate":{"id":"components/schemas/ResponseBillingProductPriceCalculate","kind":"json-schema","title":"ResponseBillingProductPriceCalculate","data":{"description":"Result of the price calculation","type":"object","properties":{"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":36,"maxLength":36,"format":"uuid"},"price_id":{"type":"string","description":"Unique product price identifier.","maxLength":36,"format":"uuid"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the product price currency."},"children":[]}]}]}],"minLength":3,"maxLength":3},"total_amount":{"type":"integer","description":"Payment total amount."},"tax":{"type":"object","description":"Information related to the tax calculation.","properties":{"tax_amount":{"type":"integer","description":"Amount of the tax calculated."},"taxable_amount":{"type":"integer","description":"Taxable amount of the transaction before tax."},"location":{"type":"string","format":"iso_code_a3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code where the tax applies, specified using an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code."},"children":[]}]}]}]},"profile_id":{"type":"string","description":"Tax profile identifier."},"rate_id":{"type":"string","description":"Tax rate identifier."},"rate":{"type":"number","format":"decimal","description":"Tax rate.","multipleOf":0.01,"maximum":99.99,"minimum":0.01},"is_included":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the tax type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - tax included"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - tax excluded"},"children":[]}]}]}]}]}},"required":["tax_amount","taxable_amount","location","profile_id","rate_id","rate","is_included"]},"recurring":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring price breakdown."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"recurring"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" product type. It is not returned when the product type is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"one_time"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"properties":{"total_amount":{"type":"integer","description":"Payment total amount."},"tax":{"type":"object","description":"Information related to the tax calculation.","properties":{"tax_amount":{"type":"integer","description":"Amount of the tax calculated."},"taxable_amount":{"type":"integer","description":"Taxable amount of the transaction before tax."},"location":{"type":"string","format":"iso_code_a3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code where the tax applies, specified using an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code."},"children":[]}]}]}]},"rate":{"type":"number","format":"decimal","description":"Tax rate.","multipleOf":0.01,"maximum":99.99,"minimum":0.01},"is_included":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the tax type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - tax included"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - tax excluded"},"children":[]}]}]}]}]}},"required":["tax_amount","taxable_amount","location","rate","is_included"]}},"required":["total_amount"]}},"required":["price_id","product_id","currency","total_amount"]}},"components/schemas/RequestBillingSubscriptionUpdate":{"id":"components/schemas/RequestBillingSubscriptionUpdate","kind":"json-schema","title":"RequestSubscriptionUpdate","data":{"title":"RequestSubscriptionUpdate","type":"object","properties":{"id":{"type":"string","description":"Unique subscription identifier.","format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier to apply to the specified subscription."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"ac43b415-5522-4373-b026-a365462f9657"},"trial_ended_at":{"type":"object","description":"Datetime to end the subscription trial.","required":["type"],"properties":{"type":{"type":"string","enum":["specific_date","immediate"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates how the trial should end."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - end trial immediately"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific_date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - end trial at specific date"},"children":[]}]}]}]}],"example":"immediate"},"date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the specific date when the trial should end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"specific_date"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Trial end date must be within 1 year from the current date."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2026-07-20 13:20:00"}}},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount details to manage subscription pricing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"To remove an existing discount, send "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"type":"object","title":"coupon_id","required":["coupon_id"],"properties":{"coupon_id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"Unique coupon identifier.","example":"379bd8d9-7f2a-44eb-be35-b741985e1b08"}}},{"type":"object","title":"coupon_code","required":["coupon_code"],"properties":{"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code for customers to redeem.","example":"PRIME50"}}}]}},"required":["id"]}},"components/schemas/SchemaBillingSubscriptionStatusPending":{"id":"components/schemas/SchemaBillingSubscriptionStatusPending","kind":"json-schema","title":"SubscriptionStatusPending","data":{"title":"SubscriptionStatusPending","type":"object","properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid","example":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"pending"},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:24"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:25"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-12 12:37:24"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"],"example":"card"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription has a trial.","example":false},"trial_started_at":{"type":"string","description":"Datetime of the subscription trial start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:24"},"trial_ended_at":{"type":"string","description":"Datetime of the subscription trial expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:25"},"cancelled_at":{"type":"string","description":"Datetime of subscription cancellation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-12 19:37:24"},"cancellation_requested_at":{"type":"string","description":"Datetime of subscription cancellation request.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-11 19:37:24"},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"],"example":"8.09"},"cancel_message":{"type":"string","description":"Cancellation reason brief description.","example":"Cancellation after redemption period"},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription pause type value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the datetime is the date and time of the pause start request."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-27 11:26:08"},"to_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-27 11:26:08"}},"required":["from_date"]}},"required":["id","status","updated_at","trial"]}},"components/schemas/SchemaBillingSubscriptionStatusActive":{"id":"components/schemas/SchemaBillingSubscriptionStatusActive","kind":"json-schema","title":"SubscriptionStatusActive","data":{"title":"SubscriptionStatusActive","type":"object","properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid","example":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"active"},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:24"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:25"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-12 12:37:24"},"next_charge_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the subsequent charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-12 14:37:24"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"],"example":"card"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription has a trial.","example":false},"trial_started_at":{"type":"string","description":"Datetime of the subscription trial start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:24"},"trial_ended_at":{"type":"string","description":"Datetime of the subscription trial expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:25"},"cancelled_at":{"type":"string","description":"Datetime of subscription cancellation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-12 19:37:24"},"cancellation_requested_at":{"type":"string","description":"Datetime of subscription cancellation request.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-11 19:37:24"},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"],"example":"8.09"},"cancel_message":{"type":"string","description":"Cancellation reason brief description.","example":"Cancellation after redemption period"},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription pause type value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the datetime is the date and time of the pause start request."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-27 11:26:08"},"to_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-27 11:26:08"}},"required":["from_date"]}},"required":["id","updated_at","started_at","trial","payment_type","status"]}},"components/schemas/SchemaBillingSubscriptionStatusCancelled":{"id":"components/schemas/SchemaBillingSubscriptionStatusCancelled","kind":"json-schema","title":"SubscriptionStatusCancelled","data":{"title":"SubscriptionStatusCancelled","type":"object","properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid","example":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"cancelled"},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:24"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:25"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-12 12:37:24"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"],"example":"card"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription has a trial.","example":false},"trial_started_at":{"type":"string","description":"Datetime of the subscription trial start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:24"},"trial_ended_at":{"type":"string","description":"Datetime of the subscription trial expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:25"},"cancelled_at":{"type":"string","description":"Datetime of subscription cancellation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-12 19:37:24"},"cancellation_requested_at":{"type":"string","description":"Datetime of subscription cancellation request.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-11 19:37:24"},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"],"example":"8.09"},"cancel_message":{"type":"string","description":"Cancellation reason brief description.","example":"Cancellation after redemption period"},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription pause type value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the datetime is the date and time of the pause start request."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-27 11:26:08"},"to_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-27 11:26:08"}},"required":["from_date"]}},"required":["id","updated_at","started_at","trial","payment_type","status"]}},"components/schemas/SchemaBillingSubscriptionStatusRedemption":{"id":"components/schemas/SchemaBillingSubscriptionStatusRedemption","kind":"json-schema","title":"SubscriptionStatusRedemption","data":{"title":"SubscriptionStatusRedemption","type":"object","properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid","example":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"redemption"},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:24"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:25"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-12 12:37:24"},"next_charge_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the subsequent charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-12 14:37:24"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"],"example":"card"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription has a trial.","example":false},"trial_started_at":{"type":"string","description":"Datetime of the subscription trial start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:24"},"trial_ended_at":{"type":"string","description":"Datetime of the subscription trial expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:25"},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"],"example":"8.09"},"cancel_message":{"type":"string","description":"Cancellation reason brief description.","example":"Cancellation after redemption period"},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription pause type value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the datetime is the date and time of the pause start request."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-27 11:26:08"},"to_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-27 11:26:08"}},"required":["from_date"]}},"required":["id","updated_at","started_at","trial","payment_type","status"]}},"components/schemas/SchemaBillingSubscriptionStatusPaused":{"id":"components/schemas/SchemaBillingSubscriptionStatusPaused","kind":"json-schema","title":"SubscriptionStatusPaused","data":{"title":"SubscriptionStatusPaused","type":"object","properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid","example":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"paused"},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:24"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:25"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-12 12:37:24"},"next_charge_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the subsequent charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-12 14:37:24"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"],"example":"card"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription has a trial.","example":false},"trial_started_at":{"type":"string","description":"Datetime of the subscription trial start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:24"},"trial_ended_at":{"type":"string","description":"Datetime of the subscription trial expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:25"},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"],"example":"8.09"},"cancel_message":{"type":"string","description":"Cancellation reason brief description.","example":"Cancellation after redemption period"},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription pause type value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the datetime is the date and time of the pause start request."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-27 11:26:08"},"to_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-27 11:26:08"}},"required":["from_date"]}},"required":["id","updated_at","started_at","trial","payment_type","status"]}},"components/schemas/SchemaBillingSubscriptionStatusExpired":{"id":"components/schemas/SchemaBillingSubscriptionStatusExpired","kind":"json-schema","title":"SubscriptionStatusExpired","data":{"title":"SubscriptionStatusExpired","type":"object","properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid","example":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"expired"},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:24"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:25"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-12 12:37:24"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"],"example":"card"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription has a trial.","example":false},"trial_started_at":{"type":"string","description":"Datetime of the subscription trial start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:24"},"trial_ended_at":{"type":"string","description":"Datetime of the subscription trial expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-08 12:37:25"},"cancelled_at":{"type":"string","description":"Datetime of subscription cancellation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-12 19:37:24"},"cancellation_requested_at":{"type":"string","description":"Datetime of subscription cancellation request.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-11 19:37:24"},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"],"example":"8.09"},"cancel_message":{"type":"string","description":"Cancellation reason brief description.","example":"Cancellation after redemption period"},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription pause type value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the datetime is the date and time of the pause start request."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-27 11:26:08"},"to_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-27 11:26:08"}},"required":["from_date"]}},"required":["id","status","updated_at","trial"]}},"components/schemas/ResponseBillingSubscriptionUpdate":{"id":"components/schemas/ResponseBillingSubscriptionUpdate","kind":"json-schema","title":"ResponseSubscriptionUpdate","data":{"title":"ResponseSubscriptionUpdate","type":"object","discriminator":{"propertyName":"status","mapping":{"pending":"#/components/schemas/SchemaBillingSubscriptionStatusPending","active":"#/components/schemas/SchemaBillingSubscriptionStatusActive","cancelled":"#/components/schemas/SchemaBillingSubscriptionStatusCancelled","redemption":"#/components/schemas/SchemaBillingSubscriptionStatusRedemption","paused":"#/components/schemas/SchemaBillingSubscriptionStatusPaused","expired":"#/components/schemas/SchemaBillingSubscriptionStatusExpired"}},"example":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-12-12 14:37:24","payment_type":"card","trial":false,"trial_started_at":"2025-12-08 12:37:24","trial_ended_at":"2025-12-08 12:37:25","cancelled_at":"2025-12-12 19:37:24","cancellation_requested_at":"2025-12-11 19:37:24","cancel_code":"8.09","cancel_message":"Cancellation after redemption period","pause":{"from_date":"2025-03-27 11:26:08","to_date":"2025-03-27 11:26:08"}}}},"components/schemas/RequestBillingSubscriptionProductSwitch":{"id":"components/schemas/RequestBillingSubscriptionProductSwitch","kind":"json-schema","title":"SubRequestSwitchProduct","data":{"title":"SubRequestSwitchProduct","type":"object","properties":{"subscription_id":{"type":"string","description":"Unique subscription identifier.","format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"},"new_product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier to apply to the specified subscription."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36,"example":"ac43b415-5522-4373-b026-a365462f9657"}},"required":["subscription_id","new_product_id"]}},"components/schemas/ResponseBillingValidationError":{"id":"components/schemas/ResponseBillingValidationError","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"error":{"type":"object","description":"Error object.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code that identifies the validation failure."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This code is returned when the input data does not meet the expected criteria."},"children":[]}]}]}],"enum":["2.01"],"example":"2.01"},"messages":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains field-specific error messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Each key is a field name. Each value is an array of strings that describe validation issues."},"children":[]}]}]}],"additionalProperties":{"type":"array","items":{"type":"string"}},"example":{"subscription":["Validation error"]}}},"required":["code","messages"]}}}},"components/schemas/RequestBillingSubscriptionStatus":{"id":"components/schemas/RequestBillingSubscriptionStatus","kind":"json-schema","title":"SubRequestSubId","data":{"title":"SubRequestSubId","type":"object","properties":{"subscription_id":{"type":"string","description":"Unique subscription identifier.","format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"}},"required":["subscription_id"]}},"components/schemas/SchemaBillingSubscriptionDiscriminator":{"id":"components/schemas/SchemaBillingSubscriptionDiscriminator","kind":"json-schema","title":"SchemaBillingSubscriptionDiscriminator","data":{"description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","properties":{"status":{"type":"string","description":"Subscription status."}},"example":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-12-12 14:37:24","payment_type":"card","trial":false,"discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial_started_at":"2025-12-08 12:37:24","trial_ended_at":"2025-12-08 12:37:25","cancelled_at":"2025-12-12 19:37:24","cancellation_requested_at":"2025-12-11 19:37:24","cancel_code":"8.09","cancel_message":"Cancellation after redemption period","pause":{"from_date":"2025-03-27 11:26:08","to_date":"2025-03-27 11:26:08"}},"discriminator":{"propertyName":"status","mapping":{"pending":"#/components/schemas/SchemaBillingSubscriptionStatusPending","active":"#/components/schemas/SchemaBillingSubscriptionStatusActive","cancelled":"#/components/schemas/SchemaBillingSubscriptionStatusCancelled","redemption":"#/components/schemas/SchemaBillingSubscriptionStatusRedemption","paused":"#/components/schemas/SchemaBillingSubscriptionStatusPaused","expired":"#/components/schemas/SchemaBillingSubscriptionStatusExpired"}}}},"components/schemas/ResponseBillingSubscriptionStatus":{"id":"components/schemas/ResponseBillingSubscriptionStatus","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"subscription":{"$ref":"#/components/schemas/SchemaBillingSubscriptionDiscriminator"},"product":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription product details, including name, pricing logic, amount, currency, trial settings, and other related attributes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The list of fields within the object differs from the field set during the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/products-and-prices/create-product","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"creation of the product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request."},"children":[]}]}]}],"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It corresponds to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" parameter."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5"},"name":{"type":"string","description":"Product name.","example":"Platinum Audiobook Set"},"payment_action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied to the first transaction."},"children":[]}]}]}],"example":"auth_void"},"price_id":{"type":"string","description":"Unique product price identifier.","maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"amount":{"description":"Product price.","type":"integer","example":100},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the product price currency."},"children":[]}]}]}],"maxLength":3,"minLength":3,"example":"USD"},"trial":{"type":"boolean","description":"Indicates whether the product has a trial.","example":true},"trial_period":{"type":"integer","description":"Indicates the trial period in minutes.","example":1},"trial_amount":{"type":"integer","description":"Trial price.","example":99},"trial_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the trial price currency."},"children":[]}]}]}],"maxLength":3,"minLength":3,"example":"USD"}},"required":["id","name","price_id","amount","currency","trial"]},"customer":{"description":"Customer details related to the subscription, including key information such as the customer's email address.","type":"object","properties":{"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100,"example":"example@example.com"}},"required":["customer_account_id","customer_email"]},"invoices":{"type":"object","required":["<invoice_id_value_#1>"],"description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single invoice, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<invoice_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique invoice identifier."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid","example":"4022a203-ace8-415f-9ae7-730014fceb25"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["processing","retry","success","fail"],"example":"success"},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation.","example":"2025-12-27 11:45:30"},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-28 11:45:30"},"amount":{"type":"integer","description":"Current subscription price.","example":100},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","description","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 2025"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}],"example":"2025-12-29 11:45:30"},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}],"example":"2025-12-30 11:45:30"},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}],"example":1},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255,"example":"1672066481283AlexKho"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"],"example":"processing"},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation.","example":"2025-12-27 11:45:30"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}],"example":"2025-12-28 11:45:30"},"amount":{"type":"integer","description":"Original order amount.","example":100},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal.","example":"123443334"},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}],"example":"example@example.com"}}},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"example":1},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}},"required":["id","status","amount","created_at"]}}}},"required":["id","amount","status","created_at","updated_at"]}}}},"required":["subscription","product","customer","invoices"]}},"components/schemas/RequestBillingSubscriptionRetrieveCustomer":{"id":"components/schemas/RequestBillingSubscriptionRetrieveCustomer","kind":"json-schema","title":"SubRequestRetrieveByCustomer","data":{"title":"SubRequestRetrieveByCustomer","type":"object","properties":{"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","example":"93a1c659-288d-4d62-929d-10e241078faa","maxLength":100}},"required":["customer_account_id"]}},"components/schemas/ResponseBillingSubscriptionRetrieveCustomer":{"id":"components/schemas/ResponseBillingSubscriptionRetrieveCustomer","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"<subscription_id_value_#1>":{"description":"Details of a subscription, including payment and customer information.","type":"object","properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid","example":"64e1c283-17bf-45a7-90ea-2cb938081b2f"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pending","active","cancelled","redemption","paused","expired"],"example":"cancelled"},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-06-10 15:42:24"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-06-10 15:42:25"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-09-10 16:42:24"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-11-26 11:43:52"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","example":"paypal-vault"},"trial":{"type":"boolean","description":"Indicates whether the subscription has a trial.","example":true},"cancelled_at":{"type":"string","description":"Datetime of subscription cancellation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-06-26 06:43:58"},"cancellation_requested_at":{"type":"string","description":"Datetime of subscription cancellation request.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-06-25 06:43:58"},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"],"example":"8.01"},"cancel_message":{"type":"string","description":"Cancellation reason brief description.","example":"Card brand is not supported"},"customer":{"description":"Customer details related to the subscription, including key information such as the customer's email address.","type":"object","properties":{"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100,"example":"example@example.com"}},"required":["customer_account_id","customer_email"]},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":"Pause start date.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-27 11:26:08"},"to_date":{"type":"string","description":"Pause end date.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-27 11:26:08"}},"required":["from_date"]}},"required":["id","updated_at","started_at","trial","payment_type","status","customer"]},"<subscription_id_value_#2>":{"description":"Details of a subscription, including payment and customer information.","type":"object","properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid","example":"64e1c283-17bf-45a7-90ea-2cb938081b2f"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pending","active","cancelled","redemption","paused","expired"],"example":"cancelled"},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-06-10 15:42:24"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-06-10 15:42:25"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-09-10 16:42:24"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-11-26 11:43:52"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","example":"paypal-vault"},"trial":{"type":"boolean","description":"Indicates whether the subscription has a trial.","example":true},"cancelled_at":{"type":"string","description":"Datetime of subscription cancellation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-06-26 06:43:58"},"cancellation_requested_at":{"type":"string","description":"Datetime of subscription cancellation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-06-25 06:43:58"},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"],"example":"8.01"},"cancel_message":{"type":"string","description":"Cancellation reason brief description.","example":"Card brand is not supported"},"customer":{"description":"Customer details related to the subscription, including key information such as the customer's email address.","type":"object","properties":{"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100,"example":"example@example.com"}},"required":["customer_account_id","customer_email"]},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":"Pause start date.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-27 11:26:08"},"to_date":{"type":"string","description":"Pause end date.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-27 11:26:08"}},"required":["from_date"]}},"required":["id","updated_at","started_at","trial","payment_type","status","customer"]}}}},"components/schemas/RequestBillingSubscriptionInvoiceListBySubscriptionID":{"id":"components/schemas/RequestBillingSubscriptionInvoiceListBySubscriptionID","kind":"json-schema","title":"SubRequestListInvoiceSubId","data":{"title":"SubRequestListInvoiceSubId","type":"object","properties":{"subscription_id":{"type":"string","description":"Unique subscription identifier.","format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"},"pagination":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the pagination of the results."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" together if either of the key-value pairs, "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"offset"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", is included in the object. For the key-value pair that is not needed, specify its default value."},"children":[]}]}]}],"properties":{"offset":{"type":"integer","description":"Starting index of the results to return.","example":20,"default":0,"minimum":0,"maximum":99999},"limit":{"type":"integer","description":"Maximum number of items to return.","example":10,"default":10,"minimum":1,"maximum":100}},"required":["offset","limit"]}},"required":["subscription_id"]}},"components/schemas/ResponseBillingSubscriptionInvoiceListBySubscriptionID":{"id":"components/schemas/ResponseBillingSubscriptionInvoiceListBySubscriptionID","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"data":{"type":"array","description":"List of invoices, each representing a billing event for a subscription.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique invoice identifier.","maxLength":36,"format":"uuid","example":"4022a203-ace8-415f-9ae7-730014fceb25"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"fail","enum":["processing","retry","success","fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation.","example":"2025-12-27 11:45:30"},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-12-28 11:45:30"},"amount":{"type":"integer","description":"Current subscription price.","example":100,"minimum":0},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period for which the invoice was paid."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}],"example":"2025-12-29 11:45:30"},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period for which the invoice was paid."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}],"example":"2025-12-30 11:45:30"},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}],"example":1}},"required":["id","amount","status","created_at","updated_at"]}},"pagination":{"type":"object","description":"Contains information about the pagination of the results.","properties":{"offset":{"type":"integer","description":"Starting index of the returned results.","example":20},"limit":{"type":"integer","description":"Maximum number of items to return.","example":10},"total_count":{"type":"integer","description":"Total count of the subscription invoices.","example":150}},"required":["offset","limit","total_count"]}},"required":["data","pagination"]}},"components/schemas/RequestBillingSubscriptionOrderListByInvoiceID":{"id":"components/schemas/RequestBillingSubscriptionOrderListByInvoiceID","kind":"json-schema","title":"SubRequestListOrderInvoiceId","data":{"title":"SubRequestListOrderInvoiceId","type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"},"pagination":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the pagination of the results."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" together if either of the key-value pairs, "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"offset"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", is included in the object. For the key-value pair that is not needed, specify its default value."},"children":[]}]}]}],"properties":{"offset":{"type":"integer","description":"Starting index of the results to return.","example":20,"default":0,"minimum":0,"maximum":99999},"limit":{"type":"integer","description":"Maximum number of items to return.","example":10,"default":10,"minimum":1,"maximum":100}},"required":["offset","limit"]}},"required":["invoice_id"]}},"components/schemas/ResponseBillingSubscriptionOrderListByInvoiceID":{"id":"components/schemas/ResponseBillingSubscriptionOrderListByInvoiceID","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"data":{"type":"array","description":"List of orders, each containing attributes like order identifier, status, type, amount, currency, and timestamps for creation and updates.","items":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255,"example":"1672066481283AlexKho"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"],"example":"processing"},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation.","example":"2025-12-27 11:45:30"},"updated_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order update.","example":"2025-12-27 11:46:30"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}],"example":"2025-12-28 11:45:30"},"amount":{"type":"integer","description":"Original order amount.","minimum":0,"example":100},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal.","example":"123443334"},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}],"example":"example@example.com"}}},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempts for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}},"required":["id","status","amount","created_at","updated_at"]}},"pagination":{"type":"object","description":"Contains information about the pagination of the results.","properties":{"offset":{"type":"integer","description":"Starting index of the returned results.","example":20},"limit":{"type":"integer","description":"Maximum number of items to return.","example":10},"total_count":{"type":"integer","description":"Total count of the subscription invoices.","example":150}},"required":["offset","limit","total_count"]}},"required":["data","pagination"]}},"components/schemas/RequestBillingSubscriptionUpdateToken":{"id":"components/schemas/RequestBillingSubscriptionUpdateToken","kind":"json-schema","title":"SubRequestUpdateToken","data":{"title":"SubRequestUpdateToken","type":"object","properties":{"subscription_id":{"type":"string","description":"Unique subscription identifier.","format":"uuid","minLength":36,"maxLength":36,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"},"token":{"type":"string","description":"Secure payment token representing sensitive payment method information.","minLength":100,"maxLength":100,"example":"uPrZ4lx6OFxDOC5wVeA0w5E2dBtDgCdGINo5jWPtxwQbsENzrFUIAUFT9rk7J0xWkpKj0NjVlEoa1ufu8fBIexEdyHFSNaPYQC7F"}},"required":["subscription_id","token"]}},"components/schemas/RequestBillingSubscriptionPauseCreate":{"id":"components/schemas/RequestBillingSubscriptionPauseCreate","kind":"json-schema","title":"RequestSubscriptionsPauseCreate","data":{"title":"RequestSubscriptionsPauseCreate","type":"object","properties":{"start_point":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the initial timestamp of the subscription pause period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, it may represent a specific date."},"children":[]}]}]}],"required":["type"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the method of defining the pause "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/pause-subscription/#manage-subscription-pause","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" start."},"children":[]}]}]}],"enum":["immediate","specific_date"],"example":"specific_date"},"date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates when the pause should start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"specific_date"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-09 12:53:12"}}},"stop_point":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the concluding timestamp of the subscription pause period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, it may represent a specific date."},"children":[]}]}]}],"required":["type"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the method of defining the pause "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/pause-subscription/#manage-subscription-pause","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end."},"children":[]}]}]}],"enum":["infinite","specific_date"],"example":"specific_date"},"date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates when the pause should end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"specific_date"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The minimum pause period between "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"start_point: date"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"stop_point: date"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1 day"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and the maximum period is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"60 years"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"specific_date"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" pause type."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-23 08:13:46"}}}},"required":["start_point","stop_point"]}},"components/schemas/ResponseBillingSubscriptionPauseCreateUpdate":{"id":"components/schemas/ResponseBillingSubscriptionPauseCreateUpdate","kind":"json-schema","title":"ResponseBillingSubscriptionPauseCreateUpdate","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique subscription identifier.","format":"uuid","example":"bd43b415-4321-6275-c137-b365462f9645"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current subscription status."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the subscription is currently ongoing and charges are recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the subscription is temporarily on hold and there are no charges"},"children":[]}]}]}]}],"enum":["active","paused"],"example":"active"},"pause":{"type":"object","description":"Contains the details of the subscription pause.","required":["from_date"],"properties":{"from_date":{"type":"string","description":"Start datetime of the subscription pause.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-09 12:53:12"},"to_date":{"description":"Planned end datetime of the subscription pause.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-23 08:13:46"}}}},"required":["pause","id","status"]}},"components/schemas/ResponseBillingSubscriptionPauseRemove":{"id":"components/schemas/ResponseBillingSubscriptionPauseRemove","kind":"json-schema","title":"ResponseBillingSubscriptionPauseRemove","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique subscription identifier.","format":"uuid","example":"bd43b415-4321-6275-c137-b365462f9645"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current subscription status."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the subscription is currently ongoing and charges are recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the subscription is temporarily on hold and there are no charges"},"children":[]}]}]}]}],"enum":["active","paused"],"example":"active"}},"required":["id","status"]}},"components/schemas/RequestBillingSubscriptionPauseUpdate":{"id":"components/schemas/RequestBillingSubscriptionPauseUpdate","kind":"json-schema","title":"RequestSubscriptionsPauseUpdate","data":{"title":"RequestSubscriptionsPauseUpdate","type":"object","properties":{"start_point":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the initial timestamp of the subscription pause period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter,  it may represent a specific date."},"children":[]}]}]}],"required":["type"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the method of defining the pause "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/pause-subscription/#manage-subscription-pause","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" start."},"children":[]}]}]}],"enum":["immediate","specific_date"],"example":"specific_date"},"date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates when the pause should start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"specific_date"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-09 12:53:12"}}},"stop_point":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the concluding timestamp of the subscription pause period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter,  it may represent a specific date."},"children":[]}]}]}],"required":["type"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the method of defining the pause "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/manage-subscription/pause-subscription/#manage-subscription-pause","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end."},"children":[]}]}]}],"enum":["infinite","specific_date"],"example":"specific_date"},"date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates when the pause should end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"specific_date"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The minimum pause period between "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"start_point: date"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"stop_point: date"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"1 day"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and the maximum period is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"60 years"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"specific_date"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" pause type."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-03-23 08:13:46"}}}}}},"components/schemas/RequestBillingSubscriptionCancel":{"id":"components/schemas/RequestBillingSubscriptionCancel","kind":"json-schema","title":"RequestSubscriptionsCancel","data":{"title":"RequestSubscriptionsCancel","type":"object","properties":{"subscription_id":{"type":"string","format":"uuid","maxLength":36,"minLength":36,"description":"Unique subscription identifier.","example":"83b19018-cbc4-45f0-899a-dda84fd2705e"},"force":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the timing of subscription cancellation."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - cancels the subscription immediately"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - cancels at the end of the billing period"},"children":[]}]}]}]}],"default":false},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"],"example":"8.01"}},"required":["subscription_id"]}},"components/schemas/RequestBillingSubscriptionCancelCustomer":{"id":"components/schemas/RequestBillingSubscriptionCancelCustomer","kind":"json-schema","title":"RequestSubscriptionsCancelCustomer","data":{"title":"RequestSubscriptionsCancelCustomer","type":"object","properties":{"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","example":"93a1c659-288d-4d62-929d-10e241078faa","maxLength":100},"force":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the timing of subscription cancellation."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - cancels the subscription immediately"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - cancels at the end of the billing period"},"children":[]}]}]}]}],"default":false},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"],"example":"8.01"}},"required":["customer_account_id"]}},"components/schemas/RequestBillingSubscriptionRestore":{"id":"components/schemas/RequestBillingSubscriptionRestore","kind":"json-schema","title":"SubRequestRestore","data":{"title":"SubRequestRestore","type":"object","properties":{"subscription_id":{"type":"string","description":"Unique subscription identifier.","format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-45f0-899a-dda84fd2705e"},"expired_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the subscription expiration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Dates in the past are automatically updated to the current date to prevent unwanted charges."},"children":[]}]}]}],"example":"2025-12-25 00:00:00","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"coupon_id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique coupon identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pass either "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"coupon_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"coupon_code"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", not both."},"children":[]}]}]}],"example":"379bd8d9-7f2a-44eb-be35-b741985e1b08"},"coupon_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupon code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pass either "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"coupon_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"coupon_code"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", not both."},"children":[]}]}]}],"example":"PRIME50"}},"required":["subscription_id"]}},"components/schemas/RequestReportsGeneral":{"id":"components/schemas/RequestReportsGeneral","kind":"json-schema","title":"ReconRequestModel","data":{"title":"ReconRequestModel","type":"object","required":["date_from","date_to"],"properties":{"filter":{"type":"string","description":"Filtering criteria for the report data.","enum":["updated_at","created_at"],"example":"created_at"},"date_from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime for the report stated in UTC+0."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-08-15 11:00:00"},"date_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime for the report stated in UTC+0."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-08-18 11:00:00"},"limit":{"type":"integer","description":"Limit value indicates the maximum number of items to be returned.","default":2000,"minimum":1,"maximum":2000,"example":2000},"next_page_iterator":{"type":"string","example":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination helps in managing large datasets by dividing them into smaller, manageable chunks."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", it indicates that all available data has been successfully retrieved by the merchant."},"children":[]}]}]}]}}}},"components/schemas/ResponseReportsCardOrders":{"id":"components/schemas/ResponseReportsCardOrders","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["orders","metadata"],"properties":{"orders":{"type":"array","description":"List of orders, each containing attributes like order identifier, status, type, amount, currency, and timestamps for creation and updates.","items":{"type":"object","required":["order_id","status","type","amount","currency","order_description","is_secured","created_at","updated_at","transactions","customer_email"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant.","maxLength":255},"order_description":{"type":"string","description":"Description of the order.","maxLength":255},"psp_order_id":{"type":"string","description":"PSP identifier generated by Solidgate."},"provider_payment_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PSP identifier generated by the PSP."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is available if the integration passed the data."},"children":[]}]}]}]},"product_id":{"type":"string","nullable":true,"description":"Unique identifier of the product associated with the order.","maxLength":36},"product_name":{"type":"string","nullable":true,"description":"Name of the product associated with the order.","maxLength":500},"product_type":{"type":"string","nullable":true,"description":"Type of the product associated with the order.","enum":["recurring","one_time"]},"subscription_id":{"type":"string","nullable":true,"description":"Unique identifier of the subscription associated with the order.","maxLength":36},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Original order amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This is the intended initial authorization amount."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the order."},"children":[]}]}]}],"maxLength":3,"minLength":3},"processing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of the payment in the smallest currency unit as it was processed by the payment service provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This amount may differ from the original order amount due to currency conversion or other processing factors."},"children":[]}]}]}]},"processing_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the payment when it was processed by payment service provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In some cases, it is different from the original currency."},"children":[]}]}]}],"minLength":3,"maxLength":3},"settled_amount":{"type":"integer","nullable":true,"description":"Total settled amount across all successful settle transactions on the order."},"settled_currency":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the settled amount."},"children":[]}]}]}],"maxLength":3,"minLength":3},"refunded_amount":{"type":"integer","nullable":true,"description":"Total refunded amount across all successful refund transactions on the order."},"refunded_currency":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the refunded amount."},"children":[]}]}]}],"maxLength":3,"minLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["processing","3ds_verify","refunded","auth_ok","auth_failed","settle_ok","partial_settled","void_ok"]},"refund":{"type":"string","nullable":true,"description":"Refund status of the order.","enum":["partial","full","failed"]},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]}],"enum":["1-click","recurring","retry","installment","rebill","moto"]},"payment_method":{"type":"string","description":"Payment method used for the transaction.","enum":["card","network-token","token","apple-pay","google-pay"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" from the initialized transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"]},"is_secured":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this was a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment."},"children":[]}]}]}]},"routing":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment routing information."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The availability of this object depends on whether routing is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/orchestration/routing/#configure-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"configured"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for your account."},"children":[]}]}]}],"properties":{"cascade_steps":{"type":"array","description":"Details of the attempts made to process the payment.","items":{"type":"object","properties":{"mid":{"type":"string","description":"Merchant identifier in Solidgate."},"mid_descriptor":{"type":"string","description":"Identifying text that appears on a customer's credit or debit card statement."},"route_id":{"type":"string","description":"Route identifier configured in Solidgate."},"cascade_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sequential number of the processing attempt in the routing cascade, fallback step number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Indicates which attempt in the fallback sequence was used to process the payment."},"children":[]}]}]}]},"segment_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the segment used for this processing attempt in the routing configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Each segment represents a specific processing configuration within a route."},"children":[]}]}]}]},"connector_account_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the connector account used for this processing attempt."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Returned only if your account uses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/orchestration/routing/#configure-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"routing v2"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]}}}}}},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name."},"customer_last_name":{"type":"string","description":"Customer's last name."},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"mid":{"type":"string","description":"Merchant identifier in Solidgate."},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for application, "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"WEB"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for desktop web, and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MOB"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for mobile web."},"children":[]}]}]}],"enum":["APP","WEB","MOB"]},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","format":"iso_code_a3","maxLength":3,"minLength":3},"error_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the declined payment."},"children":[]}]}]}]},"transactions":{"type":"array","description":"List of transactions, each containing detailed attributes such as transaction identifier, status, type, method, amount, currency, and timestamps for creation and updates.","items":{"type":"object","required":["id","operation","status","amount","currency","created_at","updated_at","card"],"properties":{"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the transaction was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Transaction amount."},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the transaction."},"children":[]}]}]}]},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["processing","success","fail","verify"]},"authorization_type":{"type":"string","enum":["final","estimated","incremental"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"original_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method used to capture the card credentials at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Not returned if not filled."},"children":[]}]}]}],"enum":["card","apple-pay","google-pay","network-token","click-to-pay"]},"descriptor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying text that appears on a customer’s bank statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It includes information about the transaction and helps the cardholder recognize the charge."},"children":[]}]}]}]},"refund_reason":{"type":"string","description":"Text description of the refund reason."},"refund_reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/refund-reasons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the refund provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This code is used to identify the reason for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" transaction operations."},"children":[]}]}]}],"minLength":4,"maxLength":4},"card":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information related to the card used in the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Object, especially in refunds, may contain "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" values."},"children":[]}]}]}],"properties":{"bank":{"type":"string","description":"Card issuer name."},"bin":{"type":"string","description":"Card issuer Bank Identification Number (BIN)."},"brand":{"type":"string","description":"Card brand."},"card_exp_month":{"type":"string","description":"Expiry month of the card."},"card_exp_year":{"type":"integer","description":"Expiry year of the card."},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$"},"card_type":{"type":"string","description":"Card type.","enum":["CREDIT","CREDIT/DEBIT","DEBIT","PREPAID","CHARGE CARD","DEFERRED DEBIT"]},"card_id":{"type":"string","description":"Unique identifier of the card used for the transaction.","format":"uuid","example":"22733af4-f6c6-4368-b7d0-98aeb0253a57"},"country":{"type":"string","description":"Card issuer country.","format":"iso_code_a3","maxLength":3,"minLength":3},"number":{"type":"string","maxLength":19,"description":"Masked card number."}}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true}}}},"metadata":{"type":"object","description":"Metadata object containing pagination and count information.","required":["next_page_iterator","count"],"properties":{"next_page_iterator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination helps in managing large datasets by dividing them into smaller, manageable chunks."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", it indicates that all available data has been successfully retrieved by the merchant."},"children":[]}]}]}]},"count":{"type":"integer","description":"Number of orders on the page."}}}}}},"components/schemas/ResponseReportsApmOrders":{"id":"components/schemas/ResponseReportsApmOrders","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["orders","metadata"],"properties":{"orders":{"type":"array","description":"List of orders, each containing attributes like order identifier, status, type, amount, currency, and timestamps for creation and updates.","items":{"type":"object","required":["order_id","status","amount","currency","order_description","customer_email","ip_address","method","created_at","updated_at","transactions"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant.","maxLength":255},"order_description":{"type":"string","description":"Order description.","maxLength":255},"product_id":{"type":"string","nullable":true,"description":"Unique identifier of the product associated with the order.","maxLength":36},"product_name":{"type":"string","nullable":true,"description":"Name of the product associated with the order.","maxLength":500},"product_type":{"type":"string","nullable":true,"description":"Type of the product associated with the order.","enum":["recurring","one_time"]},"subscription_id":{"type":"string","nullable":true,"description":"Unique identifier of the subscription associated with the order.","maxLength":36},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to process the order."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the order."},"children":[]}]}]}],"maxLength":3,"minLength":3},"processing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of the payment in the smallest currency unit as it was processed by the payment service provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This amount may differ from the original order amount due to currency conversion or other processing factors."},"children":[]}]}]}]},"processing_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the payment when it was processed by payment service provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In some cases, it is different from the original currency."},"children":[]}]}]}],"maxLength":3,"minLength":3},"settled_amount":{"type":"integer","nullable":true,"description":"Total settled amount across all successful non-refund transactions on the order."},"settled_currency":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the settled amount."},"children":[]}]}]}],"maxLength":3,"minLength":3},"refunded_amount":{"type":"integer","nullable":true,"description":"Total refunded amount across all successful refund transactions on the order."},"refunded_currency":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the refunded amount."},"children":[]}]}]}],"maxLength":3,"minLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","settle_pending","approved","declined","refunded"]},"refund":{"type":"string","nullable":true,"description":"Refund status of the order.","enum":["partial","full","failed"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","format":"iso_code_a3","maxLength":3,"minLength":3},"error_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the declined payment."},"children":[]}]}]}]},"transactions":{"type":"array","description":"List of transactions, each containing detailed attributes such as transaction identifier, status, type, method, amount, currency, and timestamps for creation and updates.","items":{"type":"object","required":["status","id","type","method","amount","currency","created_at","updated_at"],"properties":{"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"psp_transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PSP saves the encrypted payment data and responds with a unique identifier for this transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PSP uses the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"psp_transaction_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to locate the encrypted payment data for this transaction. This is the identifier generated by the provider (in our case PayPal). Only for transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"orders:method:paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the transaction was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to process the transaction."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Transaction amount."},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the transaction."},"children":[]}]}]}],"maxLength":3,"minLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","settle_pending","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}},"metadata":{"type":"object","description":"Metadata object containing pagination and count information.","properties":{"next_page_iterator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination helps in managing large datasets by dividing them into smaller, manageable chunks."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", it indicates that all available data has been successfully retrieved by the merchant."},"children":[]}]}]}]},"count":{"type":"integer","description":"Number of orders on the page."}},"required":["next_page_iterator","count"]}}}},"components/schemas/ResponseReportsSubscriptions":{"id":"components/schemas/ResponseReportsSubscriptions","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"subscriptions":{"type":"object","description":"Map of subscriptions, including detailed information such as status, payment details, cancellation info, associated customer and product data, invoice history, and pause schedule parameters.","properties":{"<subscription_id_value_#1>":{"title":"SubSubscriptionModel","description":"Details of a subscription, including payment and customer information.","type":"object","properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active","cancelled","redemption","paused"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime for the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer's payment method used for the subscription payment.","enum":["card","paypal-vault","alipay","gcash","mbway","mercadopago","upi","wechatpay","pix"]},"trial":{"type":"boolean","description":"Indicates whether the subscription has a trial."},"cancelled_at":{"type":"string","description":"Datetime of subscription cancellation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"]},"cancel_message":{"type":"string","description":"Cancellation reason brief description."},"customer":{"description":"Customer details related to the subscription, including key information such as the customer's email address.","type":"object","properties":{"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100}},"required":["customer_account_id","customer_email"]},"product":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription product details, including name, pricing logic, amount, currency, trial settings, and other related attributes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The list of fields within the object differs from the fields of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/products-and-prices/create-product","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product creation"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"maxLength":36},"name":{"type":"string","description":"Product name."},"payment_action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied to the first transaction."},"children":[]}]}]}]},"amount":{"description":"Product price.","type":"integer"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the product price currency."},"children":[]}]}]}],"maxLength":3,"minLength":3},"trial":{"type":"boolean","description":"Indicates whether the product has a trial."},"trial_period":{"type":"integer","description":"Indicates the trial period in minutes."}},"required":["id","name","amount","currency","trial"]},"invoices":{"type":"object","required":["<invoice_id_value_#1>"],"description":"Map of invoices, containing details such as a subscription's billing overview, current state, financial information, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single invoice, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<invoice_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique invoice identifier."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["processing","retry","success","fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including data such as status, creation and processing timestamps, and other transaction details.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"Unique order identifier defined by the merchant, which can be used to find the payment.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime when the order was processed."},"amount":{"type":"integer","description":"Original order amount."},"payment_details":{"title":"APMPayerDetails","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal.","example":"123443334"},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of retry attempts for the subscription payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use it for analytics and conversion tuning purposes."},"children":[]}]}]}],"minimum":0},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}},"required":["id","status","amount","created_at","processed_at","retry_attempt"]}},"required":["<order_id_value_#1>"]}},"required":["id","amount","status","created_at","updated_at","billing_period_started_at","billing_period_ended_at","subscription_term_number","orders"]}}},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":"Pause start date.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"to_date":{"type":"string","description":"Pause end date.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"}},"required":["from_date"]}},"required":["id","updated_at","started_at","trial","payment_type","status","customer","product","invoices"]}},"required":["<subscription_id_value_#1>"]},"metadata":{"type":"object","description":"Contains metadata related to the request, particularly for pagination.","properties":{"next_page_iterator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To perform pagination in the request body, add the field with the value from the previous response."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", all data was successfully retrieved by the merchant."},"children":[]}]}]}]},"count":{"type":"integer","description":"Number of subscriptions on the page."}},"required":["next_page_iterator","count"]}},"required":["subscriptions","metadata"]}},"components/schemas/ResponseReportsChargebacks":{"id":"components/schemas/ResponseReportsChargebacks","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["orders","metadata"],"properties":{"orders":{"type":"array","description":"List of orders, each containing attributes like order identifier, status, type, amount, currency, and timestamps for creation and updates.","items":{"type":"object","required":["order_id","status","type","amount","currency","order_description","is_secured","created_at","updated_at","chargebacks"],"properties":{"order_id":{"type":"string","description":"Unique order identifier defined by the merchant.","maxLength":255},"order_description":{"type":"string","description":"Description of the order.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Original order amount."},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the order."},"children":[]}]}]}],"maxLength":3,"minLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["processing","3ds_verify","refunded","auth_ok","auth_failed","settle_ok","partial_settled","void_ok"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" from the initialized transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"]},"is_secured":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this was a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/#3ds","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment."},"children":[]}]}]}]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"customer_first_name":{"type":"string","description":"Customer's first name."},"customer_last_name":{"type":"string","description":"Customer's last name."},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for antifraud checks."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device platform used by the customer at the time of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APP"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for application, "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"WEB"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for desktop web, and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MOB"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for mobile web."},"children":[]}]}]}],"enum":["MOB","WEB","APP"]},"geo_country":{"type":"string","description":"Country where the customer account is registered on the merchant platform.","format":"iso_code_a3","maxLength":3,"minLength":3},"chargebacks":{"type":"array","description":"List of chargebacks, each containing attributes such as unique identifier, creation, dispute, and settlement dates, amount, currency, type, status, and reason codes.","items":{"type":"object","required":["id","dispute_date","amount","currency","created_at","updated_at"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique chargeback identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"int64 value serialized as a string in JSON."},"children":[]}]}]}],"maxLength":100},"created_at":{"type":"string","description":"Datetime when the chargeback was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the chargeback was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"dispute_date":{"type":"string","description":"Date when the chargeback was created by the issuer.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$ || ^\\d{4}-\\d{2}-\\d{2}"},"settlement_date":{"type":"string","description":"Date when the chargeback was financially settled.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount that will be deducted for the chargeback on a specific order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This amount may vary depending on the cardholder's decision on the amount to dispute."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the chargeback amount."},"children":[]}]}]}],"maxLength":3,"minLength":3},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#types","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback."},"children":[]}]}]}],"enum":["1st_chb","2nd_chb","arbitration"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback."},"children":[]}]}]}],"enum":["in_progress","document_sent","reversed","accepted","resolved","resolved_reversal"]},"reason_group":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/reason-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" group."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It can be used for the segmentation and analytic purposes."},"children":[]}]}]}]},"reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/reason-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the chargeback provided by the card scheme."},"children":[]}]}]}]},"reason_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/reason-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" description for the chargeback provided by the card scheme."},"children":[]}]}]}]},"flows":{"type":"array","description":"List of chargeback flows, each containing attributes such as unique identifier, creation, settlement, and deadline dates, amount, currency, type, status, and ARN code.","items":{"type":"object","required":["id","amount","dispute_amount","currency","type","status","created_at","updated_at"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique chargeback flow identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"int64 value serialized as a string in JSON."},"children":[]}]}]}],"maxLength":100},"date":{"type":"string","description":"Datetime when the chargeback flow was created by Solidgate.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"created_at":{"type":"string","description":"Datetime when the chargeback flow was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the chargeback flow was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"settlement_date":{"type":"string","description":"Date when the chargeback flow was financially settled.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"deadline_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deadline for submitting a response to contest the dispute."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This corresponds to date + n, where n is a number of calendar days set by the scheme or acquirer."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount involved in each stage of the chargeback process."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For example, there can be two records in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"chargeback_flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" one with an amount of 113.58 USD and another with an amount of 100 USD."},"children":[]}]}]}]},"dispute_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific amount disputed, typically in the smallest currency unit, that is returned to the merchant if the dispute is resolved in their favor."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For example, if the second chargeback is successfully disputed, the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"dispute_amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will be 100 USD."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the chargeback amount."},"children":[]}]}]}],"minLength":3,"maxLength":3},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#types","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback flow."},"children":[]}]}]}],"enum":["1st_chb","2nd_chb","arbitration"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback flow."},"children":[]}]}]}],"enum":["in_progress","document_sent","reversed","accepted","resolved","resolved_reversal"]},"represented_by":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates which party has provided the defense document for dispute "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#respond-to-chargebacks","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"representment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["merchant","automation"]},"arn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acquirer Reference Number (ARN) assigned to transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use ARN to check transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]}}}}}}},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true}}}},"metadata":{"type":"object","description":"Metadata object containing pagination and count information.","required":["next_page_iterator","count"],"properties":{"next_page_iterator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination helps in managing large datasets by dividing them into smaller, manageable chunks."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", it indicates that all available data has been successfully retrieved by the merchant."},"children":[]}]}]}]},"count":{"type":"integer","description":"Number of orders on the page."}}}}}},"components/schemas/ResponseReportsPaypalDisputes":{"id":"components/schemas/ResponseReportsPaypalDisputes","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["disputes","metadata"],"properties":{"disputes":{"type":"array","description":"List of disputes, each containing attributes like identifiers, dates, amounts, currencies, stages, channels, reasons, and status.","items":{"type":"object","required":["dispute_id","order_id","dispute_amount","dispute_currency","reason","status","dispute_life_cycle_stage","dispute_channel","dispute_create_time","dispute_update_time","created_at","updated_at"],"properties":{"dispute_id":{"type":"string","description":"Unique dispute identifier."},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant.","maxLength":255},"subscription_product_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It corresponds to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" parameter in subscriptions."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"subscription_service_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It corresponds to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"subscription_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" parameter in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/manage-subscriptions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime when the dispute was created."},"updated_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime when the dispute was updated."},"seller_response_due_date":{"type":"string","description":"Deadline for submitting a response to the dispute.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"dispute_amount":{"type":"integer","description":"Dispute amount."},"dispute_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the dispute."},"children":[]}]}]}],"minLength":3,"maxLength":3},"dispute_life_cycle_stage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stage in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/insights/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispute lifecycle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["INQUIRY","CHARGEBACK","PRE_ARBITRATION","ARBITRATION"]},"dispute_channel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/insights/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"channel"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by which PayPal dispute has been received."},"children":[]}]}]}],"enum":["INTERNAL","EXTERNAL","ALERT"]},"dispute_create_time":{"type":"string","description":"Datetime when the dispute was created."},"dispute_update_time":{"type":"string","description":"Datetime when the dispute was updated."},"dispute_outcome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/insights/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outcome"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the dispute."},"children":[]}]}]}],"enum":["RESOLVED_BUYER_FAVOUR","RESOLVED_SELLER_FAVOUR","RESOLVED_WITH_PAYOUT","CANCELED_BY_BUYER","NONE"]},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/insights/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the received dispute."},"children":[]}]}]}],"enum":["MERCHANDISE_OR_SERVICE_NOT_RECEIVED","MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED","UNAUTHORISED","CREDIT_NOT_PROCESSED","DUPLICATE_TRANSACTION","INCORRECT_AMOUNT","PAYMENT_BY_OTHER_MEANS","CANCELED_RECURRING_BILLING","PROBLEM_WITH_REMITTANCE","OTHER"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/insights/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the PayPal dispute."},"children":[]}]}]}],"enum":["OPEN","WAITING_FOR_BUYER_RESPONSE","WAITING_FOR_SELLER_RESPONSE","UNDER_REVIEW","RESOLVED","OTHER"]},"represented_by":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates which party has provided the defense document for dispute "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/manage/#dispute-representment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"representment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["merchant","automation"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address."}}}},"metadata":{"type":"object","description":"Metadata object containing pagination and count information.","required":["next_page_iterator","count"],"properties":{"next_page_iterator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination helps in managing large datasets by dividing them into smaller, manageable chunks."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", it indicates that all available data has been successfully retrieved by the merchant."},"children":[]}]}]}]},"count":{"type":"integer","description":"Number of disputes on the page."}}}}}},"components/schemas/ResponseReportsPreventionAlerts":{"id":"components/schemas/ResponseReportsPreventionAlerts","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"report_url":{"type":"string","description":"URL for the report stored on Amazon S3, which needs to be downloaded.","example":"https://reports.solidgate.com/api/v1/prevention_alerts/report/prev_alert_220504_143924_test/download"}}}},"components/schemas/ResponseReportsFraudAlerts":{"id":"components/schemas/ResponseReportsFraudAlerts","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["alerts","metadata"],"properties":{"alerts":{"type":"array","description":"List of alerts, each containing detailed attributes such as order identifier, creation, update, and report dates, amounts in original currency and USD, fraud type, card scheme, and reason code description.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique fraud alert identifier."},"order_id":{"type":"string","description":"Unique order identifier defined by the merchant.","maxLength":255},"created_at":{"type":"string","description":"Datetime when the fraud alert was created by Solidgate.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the fraud alert was updated Solidgate.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"fraud_amount":{"type":"integer","description":"Amount of the fraud reported."},"fraud_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the fraud amount."},"children":[]}]}]}],"minLength":3,"maxLength":3},"fraud_amount_usd":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of the fraud reported in USD."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It can be used for the risk monitoring purposes."},"children":[]}]}]}]},"fraud_report_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when fraud was reported by the issuer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/card-payments/webhook-fraud-alert","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"fraud alert webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"fraud_report_"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"day"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" field has an identical meaning."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"fraud_type":{"type":"string","description":"Type of fraud detected, categorizing the nature of the fraudulent activity."},"card_scheme":{"type":"string","description":"Card scheme associated with the transaction like Visa or Mastercard, providing context on the payment network involved."},"reason_code_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed explanation of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/fraud-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the fraud alert, offering insights into why the fraud was flagged."},"children":[]}]}]}]}}}},"metadata":{"type":"object","description":"Metadata object containing pagination and count information.","properties":{"next_page_iterator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination helps in managing large datasets by dividing them into smaller, manageable chunks."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", it indicates that all available data has been successfully retrieved by the merchant."},"children":[]}]}]}]},"count":{"type":"integer","description":"Number of alerts on the page."}},"required":["next_page_iterator","count"]}}}},"components/schemas/ResponseReportsFinancialEntries":{"id":"components/schemas/ResponseReportsFinancialEntries","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"report_url":{"type":"string","description":"URL for the report stored on Amazon S3, which needs to be downloaded.","example":"https://reports.solidgate.com/api/v1/finance/financial_entries/report/fin_220808_143924_test/download"}}}},"components/schemas/ResponseReportsRoutingV2Report":{"id":"components/schemas/ResponseReportsRoutingV2Report","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["report_url"],"properties":{"report_url":{"type":"string","description":"URL for the report stored on Amazon S3, which needs to be downloaded.","example":"https://reports.solidgate.com/api/v1/routing/events/report/routing_220504_143924_test/download"}}}},"components/schemas/SchemaRisksListFieldCardId":{"id":"components/schemas/SchemaRisksListFieldCardId","kind":"json-schema","title":"SchemaRisksListFieldCardId","data":{"title":"SchemaRisksListFieldCardId","type":"object","required":["list_type","payment_field","field_value"],"properties":{"list_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of fraud prevention list, where "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pass"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an allowlist and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reject"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a blocklist."},"children":[]}]}]}],"enum":["pass","reject"]},"payment_field":{"type":"string","description":"Payment field to match against the fraud prevention list.","enum":["card_id"]},"field_value":{"type":"string","maxLength":150,"description":"Value of the payment field to match against the fraud prevention list."},"expired_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the list item."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If not provided, the item never expires."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"description":{"type":"string","description":"Reason for adding this item to the list.","maxLength":255},"created_by":{"type":"string","description":"Email address of the user who created the list item.","maxLength":255,"format":"email"}}}},"components/schemas/SchemaRisksListFieldCardHolder":{"id":"components/schemas/SchemaRisksListFieldCardHolder","kind":"json-schema","title":"SchemaRisksListFieldCardHolder","data":{"title":"SchemaRisksListFieldCardHolder","type":"object","required":["list_type","payment_field","field_value"],"properties":{"list_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of fraud prevention list, where "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pass"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an allowlist and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reject"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a blocklist."},"children":[]}]}]}],"enum":["pass","reject"]},"payment_field":{"type":"string","description":"Payment field to match against the fraud prevention list.","enum":["cardholder"]},"field_value":{"type":"string","maxLength":150,"description":"Value of the payment field to match against the fraud prevention list."},"expired_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the list item."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If not provided, the item never expires."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"description":{"type":"string","description":"Reason for adding this item to the list.","maxLength":255},"created_by":{"type":"string","description":"Email address of the user who created the list item.","maxLength":255,"format":"email"}}}},"components/schemas/SchemaRisksListFieldCustomerId":{"id":"components/schemas/SchemaRisksListFieldCustomerId","kind":"json-schema","title":"SchemaRisksListFieldCustomerId","data":{"title":"SchemaRisksListFieldCustomerId","type":"object","required":["list_type","payment_field","field_value"],"properties":{"list_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of fraud prevention list, where "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pass"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an allowlist and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reject"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a blocklist."},"children":[]}]}]}],"enum":["pass","reject"]},"payment_field":{"type":"string","description":"Payment field to match against the fraud prevention list.","enum":["customer_id"]},"field_value":{"type":"string","maxLength":150,"description":"Value of the payment field to match against the fraud prevention list."},"expired_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the list item."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If not provided, the item never expires."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"description":{"type":"string","description":"Reason for adding this item to the list.","maxLength":255},"created_by":{"type":"string","description":"Email address of the user who created the list item.","maxLength":255,"format":"email"}}}},"components/schemas/SchemaRisksListFieldCustomerEmail":{"id":"components/schemas/SchemaRisksListFieldCustomerEmail","kind":"json-schema","title":"SchemaRisksListFieldCustomerEmail","data":{"title":"SchemaRisksListFieldCustomerEmail","type":"object","required":["list_type","payment_field","field_value"],"properties":{"list_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of fraud prevention list, where "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pass"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an allowlist and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reject"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a blocklist."},"children":[]}]}]}],"enum":["pass","reject"]},"payment_field":{"type":"string","description":"Payment field to match against the fraud prevention list.","enum":["customer_email"]},"field_value":{"type":"string","format":"email","description":"Value of the payment field to match against the fraud prevention list."},"expired_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the list item."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If not provided, the item never expires."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"description":{"type":"string","description":"Reason for adding this item to the list.","maxLength":255},"created_by":{"type":"string","description":"Email address of the user who created the list item.","maxLength":255,"format":"email"}}}},"components/schemas/SchemaRisksListFieldIpAddress":{"id":"components/schemas/SchemaRisksListFieldIpAddress","kind":"json-schema","title":"SchemaRisksListFieldIpAddress","data":{"title":"SchemaRisksListFieldIpAddress","type":"object","required":["list_type","payment_field","field_value"],"properties":{"list_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of fraud prevention list, where "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pass"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an allowlist and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reject"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a blocklist."},"children":[]}]}]}],"enum":["pass","reject"]},"payment_field":{"type":"string","description":"Payment field to match against the fraud prevention list.","enum":["ip_address"]},"field_value":{"type":"string","format":"ipv4","description":"Value of the payment field to match against the fraud prevention list."},"expired_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the list item."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If not provided, the item never expires."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"description":{"type":"string","description":"Reason for adding this item to the list.","maxLength":255},"created_by":{"type":"string","description":"Email address of the user who created the list item.","maxLength":255,"format":"email"}}}},"components/schemas/RequestRisksFraudPreventionListItemsCreate":{"id":"components/schemas/RequestRisksFraudPreventionListItemsCreate","kind":"json-schema","title":"RequestRisksFraudPreventionListItemsCreate","data":{"title":"RequestRisksFraudPreventionListItemsCreate","type":"object","required":["items"],"properties":{"items":{"type":"array","description":"List of fraud prevention list items to be created.","maxItems":100,"items":{"properties":{"payment_field":{"description":"Payment field to match against the fraud prevention list.","enum":["card_id","cardholder","customer_id","customer_email","ip_address"]}},"discriminator":{"propertyName":"payment_field","mapping":{"card_id":"#/components/schemas/SchemaRisksListFieldCardId","cardholder":"#/components/schemas/SchemaRisksListFieldCardHolder","customer_id":"#/components/schemas/SchemaRisksListFieldCustomerId","customer_email":"#/components/schemas/SchemaRisksListFieldCustomerEmail","ip_address":"#/components/schemas/SchemaRisksListFieldIpAddress"}}}}}}},"components/schemas/ResponseRisksFraudPreventionListItem":{"id":"components/schemas/ResponseRisksFraudPreventionListItem","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["id","list_type","payment_field","field_value"],"properties":{"id":{"type":"string","description":"Unique identifier of the fraud prevention list item.","maxLength":255},"list_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of fraud prevention list, where "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pass"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an allowlist and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reject"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a blocklist."},"children":[]}]}]}],"enum":["pass","reject"]},"payment_field":{"type":"string","description":"Payment field to match against the fraud prevention list.","enum":["card_id","cardholder","customer_id","customer_email","ip_address"]},"field_value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the payment field to match against the fraud prevention list."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the value provided in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_field"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the corresponding validation rules are enforced."},"children":[]}]}]}]},"created_at":{"type":"string","description":"Creation date of the list item."},"expired_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the list item."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If not provided, the item never expires."},"children":[]}]}]}]},"description":{"type":"string","description":"Reason for adding this item to the list.","maxLength":255},"created_by":{"type":"string","description":"Email address of the user who created the list item.","maxLength":255,"format":"email"}}}},"components/schemas/ResponseRisksFraudPreventionListItemsCreate":{"id":"components/schemas/ResponseRisksFraudPreventionListItemsCreate","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["items"],"properties":{"items":{"type":"array","description":"List of created fraud prevention list items.","items":{"$ref":"#/components/schemas/ResponseRisksFraudPreventionListItem"}}}}},"components/schemas/SchemaRisksListFieldValueCardId":{"id":"components/schemas/SchemaRisksListFieldValueCardId","kind":"json-schema","title":"SchemaRisksListFieldValueCardId","data":{"title":"SchemaRisksListFieldValueCardId","type":"object","required":["payment_field"],"properties":{"payment_field":{"type":"string","description":"Payment field to match against the fraud prevention list.","enum":["card_id"]},"field_value":{"type":"string","maxLength":150,"description":"Value of the payment field to match against the fraud prevention list."}}}},"components/schemas/SchemaRisksListFieldValueCardHolder":{"id":"components/schemas/SchemaRisksListFieldValueCardHolder","kind":"json-schema","title":"SchemaRisksListFieldValueCardHolder","data":{"title":"SchemaRisksListFieldValueCardHolder","type":"object","required":["payment_field"],"properties":{"payment_field":{"type":"string","description":"Payment field to match against the fraud prevention list.","enum":["cardholder"]},"field_value":{"type":"string","maxLength":150,"description":"Value of the payment field to match against the fraud prevention list."}}}},"components/schemas/SchemaRisksListFieldValueCustomerId":{"id":"components/schemas/SchemaRisksListFieldValueCustomerId","kind":"json-schema","title":"SchemaRisksListFieldValueCustomerId","data":{"title":"SchemaRisksListFieldValueCustomerId","type":"object","required":["payment_field"],"properties":{"payment_field":{"type":"string","description":"Payment field to match against the fraud prevention list.","enum":["customer_id"]},"field_value":{"type":"string","maxLength":150,"description":"Value of the payment field to match against the fraud prevention list."}}}},"components/schemas/SchemaRisksListFieldValueCustomerEmail":{"id":"components/schemas/SchemaRisksListFieldValueCustomerEmail","kind":"json-schema","title":"SchemaRisksListFieldValueCustomerEmail","data":{"title":"SchemaRisksListFieldValueCustomerEmail","type":"object","required":["payment_field"],"properties":{"payment_field":{"type":"string","description":"Payment field to match against the fraud prevention list.","enum":["customer_email"]},"field_value":{"type":"string","format":"email","description":"Value of the payment field to match against the fraud prevention list."}}}},"components/schemas/SchemaRisksListFieldValueIpAddress":{"id":"components/schemas/SchemaRisksListFieldValueIpAddress","kind":"json-schema","title":"SchemaRisksListFieldValueIpAddress","data":{"title":"SchemaRisksListFieldValueIpAddress","type":"object","required":["payment_field"],"properties":{"payment_field":{"type":"string","description":"Payment field to match against the fraud prevention list.","enum":["ip_address"]},"field_value":{"type":"string","format":"ipv4","description":"Value of the payment field to match against the fraud prevention list."}}}},"components/schemas/RequestRisksFraudPreventionListItemList":{"id":"components/schemas/RequestRisksFraudPreventionListItemList","kind":"json-schema","title":"RequestRisksFraudPreventionListItemList","data":{"title":"RequestRisksFraudPreventionListItemList","type":"object","properties":{"list_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of fraud prevention list, where "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pass"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an allowlist and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reject"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a blocklist."},"children":[]}]}]}],"enum":["pass","reject"]},"payment_field_value":{"type":"object","description":"Payment field and value to match against the fraud prevention list.","required":["payment_field"],"properties":{"payment_field":{"type":"string","description":"Payment field to match against the fraud prevention list.","enum":["card_id","cardholder","customer_id","customer_email","ip_address"]}},"discriminator":{"propertyName":"payment_field","mapping":{"card_id":"#/components/schemas/SchemaRisksListFieldValueCardId","cardholder":"#/components/schemas/SchemaRisksListFieldValueCardHolder","customer_id":"#/components/schemas/SchemaRisksListFieldValueCustomerId","customer_email":"#/components/schemas/SchemaRisksListFieldValueCustomerEmail","ip_address":"#/components/schemas/SchemaRisksListFieldValueIpAddress"}}},"include_deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to include deleted items in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If is not set, or set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", only active items are returned."},"children":[]}]}]}]},"created_at_from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items created after datetime stated in UTC+0."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-08-15 11:00:00"},"created_at_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items created before datetime stated in UTC+0."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-08-18 11:00:00"},"limit":{"type":"integer","description":"Limit value indicates the maximum number of items to be returned.","default":2000,"minimum":1,"maximum":2000},"next_page_iterator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference point for retrieving the next page of results"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", it indicates that all available data has been successfully retrieved by the merchant."},"children":[]}]}]}]}}}},"components/schemas/ResponseRisksFraudPreventionListListItem":{"id":"components/schemas/ResponseRisksFraudPreventionListListItem","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["id","list_type","payment_field","field_value"],"properties":{"id":{"type":"string","description":"Unique identifier of the fraud prevention list item.","maxLength":255},"list_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of fraud prevention list, where "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pass"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an allowlist and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reject"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a blocklist."},"children":[]}]}]}],"enum":["pass","reject"]},"payment_field":{"type":"string","description":"Payment field to match against the fraud prevention list.","enum":["card_id","cardholder","customer_id","customer_email","ip_address"]},"field_value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the payment field to match against the fraud prevention list."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the value provided in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"payment_field"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the corresponding validation rules are enforced."},"children":[]}]}]}]},"created_at":{"type":"string","description":"Creation date of the list item."},"expired_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the list item."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If not provided, the item never expires."},"children":[]}]}]}]},"deleted_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletion date of the list item."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If not provided, the item is not deleted."},"children":[]}]}]}]},"description":{"type":"string","description":"Reason for adding this item to the list.","maxLength":255},"created_by":{"type":"string","description":"Email address of the user who created the list item.","maxLength":255,"format":"email"}}}},"components/schemas/ResponseRisksFraudPreventionListItemList":{"id":"components/schemas/ResponseRisksFraudPreventionListItemList","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["items","metadata"],"properties":{"items":{"type":"array","description":"Fraud prevention list items.","items":{"$ref":"#/components/schemas/ResponseRisksFraudPreventionListListItem"}},"metadata":{"type":"object","description":"Metadata object containing pagination and count information.","required":["next_page_iterator","count"],"properties":{"next_page_iterator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference point for retrieving the next page of results"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", it indicates that all available data has been successfully retrieved by the merchant."},"children":[]}]}]}]},"count":{"type":"integer","description":"Number of list rules on the page."}}}}}},"components/schemas/RequestRisksDisputeRepresentmentsCreateCard":{"id":"components/schemas/RequestRisksDisputeRepresentmentsCreateCard","kind":"json-schema","title":"RequestRisksDisputeRepresentmentsCreateCard","data":{"title":"RequestRisksDisputeRepresentmentsCreateCard","type":"object","required":["dispute_type","dispute_id","evidence_file_id"],"properties":{"dispute_type":{"type":"string","description":"Type of represented dispute.","enum":["card"]},"dispute_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the represented dispute that corresponds to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargebacks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/reports/retrieve-card-chargebacks","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargebacks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"evidence_file_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the evidence file."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#respond-to-chargebacks","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"file"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" size not exceeding 2 MB (2097152 bytes)."},"children":[]}]}]}]}}}},"components/schemas/RequestRisksDisputeRepresentmentsCreatePaypal":{"id":"components/schemas/RequestRisksDisputeRepresentmentsCreatePaypal","kind":"json-schema","title":"RequestRisksDisputeRepresentmentsCreatePaypal","data":{"title":"RequestRisksDisputeRepresentmentsCreatePaypal","type":"object","required":["dispute_type","dispute_id","evidence_file_id"],"properties":{"dispute_type":{"type":"string","description":"Type of represented dispute.","enum":["paypal"]},"dispute_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the represented dispute that corresponds to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispute_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/reports/retrieve-apm-paypal-disputes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" disputes."},"children":[]}]}]}]},"evidence_file_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the evidence file."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/manage/#dispute-representment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"file"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" size not exceeding 10 MB (10485760 bytes)."},"children":[]}]}]}]}}}},"components/schemas/RequestRisksDisputeRepresentmentsCreateDiscriminator":{"id":"components/schemas/RequestRisksDisputeRepresentmentsCreateDiscriminator","kind":"json-schema","title":"SchemaRisksDisputeRepresentmentsCreateDiscriminator","data":{"title":"SchemaRisksDisputeRepresentmentsCreateDiscriminator","type":"object","discriminator":{"propertyName":"dispute_type","mapping":{"card":"#/components/schemas/RequestRisksDisputeRepresentmentsCreateCard","paypal":"#/components/schemas/RequestRisksDisputeRepresentmentsCreatePaypal"}}}},"components/schemas/ResponseRisksDisputeRepresentmentsCreate":{"id":"components/schemas/ResponseRisksDisputeRepresentmentsCreate","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the created dispute representment.","maxLength":255}}}},"components/schemas/ResponseRisksBadRequest":{"id":"components/schemas/ResponseRisksBadRequest","kind":"json-schema","title":"ResponseRisksBadRequest","data":{"type":"object","properties":{"error":{"required":["code","message"],"type":"object","description":"Error object.","properties":{"code":{"type":"string","description":"Error code.","example":"2.01"},"message":{"type":"string","description":"Error message.","example":"Validation error"},"constraints":{"type":"object","description":"Map of constraints.","additionalProperties":{"type":"array","description":"Dynamic map where keys represent the field names that failed validation, and values are arrays of objects detailing the constraint violations.","items":{"properties":{"code":{"type":"string","description":"Error code.","example":"NotNull"},"message":{"type":"string","description":"Error message.","example":"must not be null"}}}}}}}},"required":["error"]}},"components/schemas/SchemaRisksErrorDisputeNotFound":{"id":"components/schemas/SchemaRisksErrorDisputeNotFound","kind":"json-schema","title":"SchemaRisksErrorDisputeNotFound","data":{"title":"SchemaRisksErrorDisputeNotFound","type":"object","properties":{"code":{"type":"string","description":"Error 2.01 code.","enum":["2.01"],"example":"2.01"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute not found."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Specified dispute not found in the system."},"children":[]}]}]}]}},"required":["code","message"]}},"components/schemas/SchemaRisksErrorFileNotFound":{"id":"components/schemas/SchemaRisksErrorFileNotFound","kind":"json-schema","title":"SchemaRisksErrorFileNotFound","data":{"title":"SchemaRisksErrorFileNotFound","type":"object","properties":{"code":{"type":"string","description":"Error 2.01 code.","enum":["2.01"],"example":"2.01"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File not found."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"File with provided ID not found."},"children":[]}]}]}]}},"required":["code","message"]}},"components/schemas/SchemaRisksErrorNotFoundDiscriminator":{"id":"components/schemas/SchemaRisksErrorNotFoundDiscriminator","kind":"json-schema","title":"SchemaRisksErrorNotFoundDiscriminator","data":{"title":"SchemaRisksErrorNotFoundDiscriminator","description":"Error object.","properties":{"code":{"type":"string"}},"discriminator":{"propertyName":"code","mapping":{"2.01 Dispute not found":"#/components/schemas/SchemaRisksErrorDisputeNotFound","2.01 File not found":"#/components/schemas/SchemaRisksErrorFileNotFound"}}}},"components/schemas/ResponseRisksNotFoundError":{"id":"components/schemas/ResponseRisksNotFoundError","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"error":{"$ref":"#/components/schemas/SchemaRisksErrorNotFoundDiscriminator"}},"required":["error"]}},"components/schemas/SchemaRisksErrorFileNotReady":{"id":"components/schemas/SchemaRisksErrorFileNotReady","kind":"json-schema","title":"SchemaRisksErrorFileNotReady","data":{"title":"SchemaRisksErrorFileNotReady","type":"object","properties":{"code":{"type":"string","description":"Error 2.01 code.","enum":["2.01"],"example":"2.01"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File not ready."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"File object was created, but its content uploaded was not completed yet."},"children":[]}]}]}]}},"required":["code","message"]}},"components/schemas/SchemaRisksErrorFileSizeExceeded":{"id":"components/schemas/SchemaRisksErrorFileSizeExceeded","kind":"json-schema","title":"SchemaRisksErrorFileSizeExceeded","data":{"title":"SchemaRisksErrorFileSizeExceeded","type":"object","properties":{"code":{"type":"string","description":"Error 2.01 code.","enum":["2.01"],"example":"2.01"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File size exceeded."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Evidence file size exceeds the limit for the requested dispute type."},"children":[]}]}]}]}},"required":["code","message"]}},"components/schemas/SchemaRisksErrorFileTypeNotSupported":{"id":"components/schemas/SchemaRisksErrorFileTypeNotSupported","kind":"json-schema","title":"SchemaRisksErrorFileTypeNotSupported","data":{"title":"SchemaRisksErrorFileTypeNotSupported","type":"object","properties":{"code":{"type":"string","description":"Error 2.01 code.","enum":["2.01"],"example":"2.01"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File type not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Evidence file type is not suitable for dispute representment."},"children":[]}]}]}]}},"required":["code","message"]}},"components/schemas/SchemaRisksErrorRepresentmentExists":{"id":"components/schemas/SchemaRisksErrorRepresentmentExists","kind":"json-schema","title":"SchemaRisksErrorRepresentmentExists","data":{"title":"SchemaRisksErrorRepresentmentExists","type":"object","properties":{"code":{"type":"string","description":"Error 2.01 code.","enum":["2.01"],"example":"2.01"},"message":{"type":"string","description":"Representment already exists."}},"required":["code","message"]}},"components/schemas/SchemaRisksErrorRepresentmentNotPossible":{"id":"components/schemas/SchemaRisksErrorRepresentmentNotPossible","kind":"json-schema","title":"SchemaRisksErrorRepresentmentNotPossible","data":{"title":"SchemaRisksErrorRepresentmentNotPossible","type":"object","properties":{"code":{"type":"string","description":"Error 2.01 code.","enum":["2.01"],"example":"2.01"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Representment not possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The representment is not possible due to the current state of the dispute."},"children":[]}]}]}]}},"required":["code","message"]}},"components/schemas/SchemaRisksErrorDiscriminator":{"id":"components/schemas/SchemaRisksErrorDiscriminator","kind":"json-schema","title":"SchemaRisksErrorDiscriminator","data":{"title":"SchemaRisksErrorDiscriminator","description":"Error object.","properties":{"code":{"type":"string"}},"discriminator":{"propertyName":"code","mapping":{"2.01 File not ready":"#/components/schemas/SchemaRisksErrorFileNotReady","2.01 File size exceeded":"#/components/schemas/SchemaRisksErrorFileSizeExceeded","2.01 File type not supported":"#/components/schemas/SchemaRisksErrorFileTypeNotSupported","2.01 Representment already exists":"#/components/schemas/SchemaRisksErrorRepresentmentExists","2.01 Representment not possible":"#/components/schemas/SchemaRisksErrorRepresentmentNotPossible"}}}},"components/schemas/ResponseRisksError":{"id":"components/schemas/ResponseRisksError","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"error":{"$ref":"#/components/schemas/SchemaRisksErrorDiscriminator"}},"required":["error"]}},"components/schemas/SchemaRisksRepresentmentEnrichmentContentItem":{"id":"components/schemas/SchemaRisksRepresentmentEnrichmentContentItem","kind":"json-schema","title":"SchemaRisksRepresentmentEnrichmentContentItem","data":{"title":"SchemaRisksRepresentmentEnrichmentContentItem","description":"Single block of dispute representment enrichment.","type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the enrichment content file."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided for the uploaded file"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" one of extensions jpg, jpeg, png, pdf, csv, txt, docx. File size does not exceed 0.5 MB (524288 bytes)."},"children":[]}]}]}]},"annotation":{"type":"string","maxLength":500,"description":"Annotation for the enrichment file."}}}},"components/schemas/SchemaRisksRepresentmentEnrichmentContent":{"id":"components/schemas/SchemaRisksRepresentmentEnrichmentContent","kind":"json-schema","title":"SchemaRisksRepresentmentEnrichmentContent","data":{"title":"SchemaRisksRepresentmentEnrichmentContent","description":"Additional enrichment content for dispute representment.","type":"object","properties":{"proof_of_communication":{"type":"array","description":"Emails, chat logs, or support tickets showing cardholder interaction.","maxItems":3,"items":{"$ref":"#/components/schemas/SchemaRisksRepresentmentEnrichmentContentItem"}},"application_logs":{"type":"array","description":"System logs providing technical evidence of the transaction or user activity.","maxItems":3,"items":{"$ref":"#/components/schemas/SchemaRisksRepresentmentEnrichmentContentItem"}},"proof_of_delivery":{"type":"array","description":"Shipping confirmations, tracking info, or signed delivery receipts.","maxItems":3,"items":{"$ref":"#/components/schemas/SchemaRisksRepresentmentEnrichmentContentItem"}},"invoice":{"type":"array","description":"Invoice documents with itemized charges and billing details.","maxItems":3,"items":{"$ref":"#/components/schemas/SchemaRisksRepresentmentEnrichmentContentItem"}},"receipts":{"type":"array","description":"Transaction receipts or payment confirmations.","maxItems":3,"items":{"$ref":"#/components/schemas/SchemaRisksRepresentmentEnrichmentContentItem"}},"other":{"type":"array","description":"Additional supporting documents not covered by other categories.","maxItems":3,"items":{"$ref":"#/components/schemas/SchemaRisksRepresentmentEnrichmentContentItem"}}}}},"components/schemas/RequestRisksDisputeRepresentmentsEnrichCard":{"id":"components/schemas/RequestRisksDisputeRepresentmentsEnrichCard","kind":"json-schema","title":"RequestRisksDisputeRepresentmentsEnrichCard","data":{"title":"RequestRisksDisputeRepresentmentsEnrichCard","type":"object","required":["dispute_type","dispute_id","enrichment"],"properties":{"dispute_type":{"type":"string","description":"Type of represented dispute.","enum":["card"]},"dispute_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the represented dispute that corresponds to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargebacks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/reports/retrieve-card-chargebacks","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargebacks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"enrichment":{"$ref":"#/components/schemas/SchemaRisksRepresentmentEnrichmentContent"},"submit":{"type":"boolean","default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit the dispute representment after including provided enrichment content."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the representment file with enrichment content will be created,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but not submitted immediately."},"children":[]}]}]}]}}}},"components/schemas/RequestRisksDisputeRepresentmentsEnrichPayPal":{"id":"components/schemas/RequestRisksDisputeRepresentmentsEnrichPayPal","kind":"json-schema","title":"RequestRisksDisputeRepresentmentsEnrichPayPal","data":{"title":"RequestRisksDisputeRepresentmentsEnrichPayPal","type":"object","required":["dispute_type","dispute_id","enrichment"],"properties":{"dispute_type":{"type":"string","description":"Type of represented dispute.","enum":["paypal"]},"dispute_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the represented dispute that corresponds to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispute_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/reports/retrieve-apm-paypal-disputes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" disputes."},"children":[]}]}]}]},"enrichment":{"$ref":"#/components/schemas/SchemaRisksRepresentmentEnrichmentContent"},"submit":{"type":"boolean","default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit the dispute representment after including provided enrichment content."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the representment file with enrichment content will be created,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but not submitted immediately."},"children":[]}]}]}]}}}},"components/schemas/RequestRisksDisputeRepresentmentsEnrichDiscriminator":{"id":"components/schemas/RequestRisksDisputeRepresentmentsEnrichDiscriminator","kind":"json-schema","title":"SchemaRisksDisputeRepresentmentsEnrichDiscriminator","data":{"title":"SchemaRisksDisputeRepresentmentsEnrichDiscriminator","type":"object","oneOf":[{"$ref":"#/components/schemas/RequestRisksDisputeRepresentmentsEnrichCard"},{"$ref":"#/components/schemas/RequestRisksDisputeRepresentmentsEnrichPayPal"}],"discriminator":{"propertyName":"dispute_type","mapping":{"card":"#/components/schemas/RequestRisksDisputeRepresentmentsEnrichCard","paypal":"#/components/schemas/RequestRisksDisputeRepresentmentsEnrichPayPal"}}}},"components/schemas/ResponseRisksDisputeRepresentmentsEnrich":{"id":"components/schemas/ResponseRisksDisputeRepresentmentsEnrich","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","description":"Empty response body for successful enrichment request.","additionalProperties":false}},"components/schemas/SchemaRisksErrorTotalFileSizeExceeded":{"id":"components/schemas/SchemaRisksErrorTotalFileSizeExceeded","kind":"json-schema","title":"SchemaRisksErrorTotalFileSizeExceeded","data":{"title":"SchemaRisksErrorTotalFileSizeExceeded","type":"object","properties":{"code":{"type":"string","description":"Error 2.01 code.","enum":["2.01"],"example":"2.01"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total files size exceeded."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Total size of evidence enrichment files exceeds the limit for the requested dispute."},"children":[]}]}]}]}},"required":["code","message"]}},"components/schemas/SchemaRisksErrorEnrichmentNotPossible":{"id":"components/schemas/SchemaRisksErrorEnrichmentNotPossible","kind":"json-schema","title":"SchemaRisksErrorEnrichmentNotPossible","data":{"title":"SchemaRisksErrorEnrichmentNotPossible","type":"object","properties":{"code":{"type":"string","description":"Error 2.01 code.","enum":["2.01"],"example":"2.01"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Representment enrichment not possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The representment enrichment is not possible due to the current state of the dispute representment."},"children":[]}]}]}]}},"required":["code","message"]}},"components/schemas/SchemaRisksEnrichErrorDiscriminator":{"id":"components/schemas/SchemaRisksEnrichErrorDiscriminator","kind":"json-schema","title":"SchemaRisksEnrichErrorDiscriminator","data":{"title":"SchemaRisksEnrichErrorDiscriminator","description":"Error object.","properties":{"code":{"type":"string"}},"discriminator":{"propertyName":"code","mapping":{"2.01 File not ready":"#/components/schemas/SchemaRisksErrorFileNotReady","2.01 File size exceeded":"#/components/schemas/SchemaRisksErrorFileSizeExceeded","2.01 Total files size exceeded":"#/components/schemas/SchemaRisksErrorTotalFileSizeExceeded","2.01 File type not supported":"#/components/schemas/SchemaRisksErrorFileTypeNotSupported","2.01 Enrichment not possible":"#/components/schemas/SchemaRisksErrorEnrichmentNotPossible"}}}},"components/schemas/ResponseRisksEnrichError":{"id":"components/schemas/ResponseRisksEnrichError","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"error":{"$ref":"#/components/schemas/SchemaRisksEnrichErrorDiscriminator"}},"required":["error"]}},"components/schemas/RequestFilesCreateFileUpload":{"id":"components/schemas/RequestFilesCreateFileUpload","kind":"json-schema","title":"RequestFilesCreateFileUpload","data":{"type":"object","required":["file_name","file_type","file_size"],"properties":{"file_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the file, including its extension."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" one of extensions jpg, jpeg, png, gif, txt, pdf, doc, docx, rtf, xls, xlsx, csv."},"children":[]}]}]}],"example":"document.pdf","pattern":"^[\\w,\\s-]+\\.[A-Za-z]{3,4}$","minLength":1,"maxLength":255},"file_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mime type of the file, must match the extension."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" one of the following mime types image/jpeg for .jpg/.jpeg, image/png for .png, image/gif for .gif, etc."},"children":[]}]}]}],"example":"application/pdf"},"file_size":{"type":"integer","description":"Size of the file in bytes.","example":1024000,"minimum":1,"maximum":52428800,"exclusiveMaximum":true}}}},"components/schemas/ResponseFilesCreateFileUpload":{"id":"components/schemas/ResponseFilesCreateFileUpload","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["file_id","upload_url"],"properties":{"file_id":{"type":"string","description":"Unique identifier of the uploaded file.","maxLength":255},"upload_url":{"type":"string","description":"Pre-signed URL for file content upload.","format":"uri"}}}},"components/schemas/SchemaFilesErrorFileInvalidRequest":{"id":"components/schemas/SchemaFilesErrorFileInvalidRequest","kind":"json-schema","title":"SchemaFilesErrorFileInvalidRequest","data":{"title":"SchemaFilesErrorFileInvalidRequest","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error 2.01 code.","enum":["2.01"],"example":"2.01"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Missing or incorrect parameters."},"children":[]}]}]}]},"constraints":{"type":"object","description":"Constraints for invalid request parameters.","properties":{"file_type":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Error code for invalid file extension.","example":"InvalidExtension"},"message":{"type":"string","description":"Message explaining why the file extension is not supported.","example":"file_type extension is not supported"}}}},"file_size":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Error code for invalid file size.","example":"InvalidSize"},"message":{"type":"string","description":"Message explaining why the file size is not allowed.","example":"file_size must be less than 52428800 bytes"}}}}}}}}},"components/schemas/SchemaFilesErrorFileSizeExceeded":{"id":"components/schemas/SchemaFilesErrorFileSizeExceeded","kind":"json-schema","title":"SchemaFilesErrorFileSizeExceeded","data":{"title":"SchemaFilesErrorFileSizeExceeded","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error 2.01 code.","enum":["2.01"],"example":"2.01"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File size exceeded."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Evidence file size exceeds the allowed limit."},"children":[]}]}]}]}}}},"components/schemas/SchemaFilesErrorFileTypeNotSupported":{"id":"components/schemas/SchemaFilesErrorFileTypeNotSupported","kind":"json-schema","title":"SchemaFilesErrorFileTypeNotSupported","data":{"title":"SchemaFilesErrorFileTypeNotSupported","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error 2.01 code.","enum":["2.01"],"example":"2.01"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File type not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Evidence file type is not suitable."},"children":[]}]}]}]}}}},"components/schemas/SchemaFilesErrorDiscriminator":{"id":"components/schemas/SchemaFilesErrorDiscriminator","kind":"json-schema","title":"SchemaFilesErrorDiscriminator","data":{"title":"SchemaFilesErrorDiscriminator","description":"Error object.","properties":{"code":{"type":"string"}},"discriminator":{"propertyName":"code","mapping":{"2.01 Invalid request":"#/components/schemas/SchemaFilesErrorFileInvalidRequest","2.01 File size exceeded":"#/components/schemas/SchemaFilesErrorFileSizeExceeded","2.01 File type not supported":"#/components/schemas/SchemaFilesErrorFileTypeNotSupported"}}}},"components/schemas/ResponseFilesError":{"id":"components/schemas/ResponseFilesError","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"error":{"$ref":"#/components/schemas/SchemaFilesErrorDiscriminator"}},"required":["error"]}},"components/schemas/SchemaWebhooksStatus":{"id":"components/schemas/SchemaWebhooksStatus","kind":"json-schema","title":"WebhookEndpointStatus","data":{"title":"WebhookEndpointStatus","type":"string","description":"Webhook endpoint status.","enum":["active","inactive"],"default":"active"}},"components/schemas/ResponseWebhooks":{"id":"components/schemas/ResponseWebhooks","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","description":"Response object for a webhook endpoint.","properties":{"id":{"type":"string","description":"Webhook endpoint identifier."},"url":{"type":"string","description":"URL for webhook event delivery."},"event_types":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#manage-webhooks","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the webhook endpoint is subscribed to."},"children":[]}]}]}],"items":{"type":"string"}},"name":{"type":"string","description":"Field for storing the webhook configuration name."},"status":{"$ref":"#/components/schemas/SchemaWebhooksStatus"},"created_at":{"type":"string","description":"Date when the webhook endpoint was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Date when the webhook endpoint was last updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"}}}},"components/schemas/ResponseWebhookEndpointList":{"id":"components/schemas/ResponseWebhookEndpointList","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","properties":{"data":{"type":"array","description":"Contains an array of webhook data, each representing a specific webhook configuration.","items":{"$ref":"#/components/schemas/ResponseWebhooks"}},"pagination":{"type":"object","description":"Contains information about the pagination of the results.","properties":{"offset":{"type":"integer","description":"Starting index of the returned results.","example":20},"limit":{"type":"integer","description":"Maximum number of items to return.","example":10},"total_count":{"type":"integer","description":"Total count of the webhook endpoints available.","example":150}},"required":["offset","limit","total_count"]}}}},"components/schemas/ResponseWebhooksInvalidRequest":{"id":"components/schemas/ResponseWebhooksInvalidRequest","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"error":{"type":"object","description":"Error object.","required":["code","message"],"properties":{"code":{"type":"string","description":"Error 2.01 code.","enum":["2.01"]},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Missing or incorrect parameters."},"children":[]}]}]}]},"constraints":{"type":"object","description":"An object containing validation errors for specific fields. \nKeys are field names, and values are lists of violations with error codes and messages."}}}}}},"components/schemas/SchemaWebhooksEventType":{"id":"components/schemas/SchemaWebhooksEventType","kind":"json-schema","title":"WebhookEndpointEventType","data":{"title":"WebhookEndpointEventType","type":"string","enum":["card_gate.order.updated","card_gate.chargeback.received","card_gate.fraud_alert.received","card_gate.prevention_alert.received","subscription.updated.v2","alt_gate.order.updated","alt_gate.paypal_dispute.received","card.network_token.created","card.network_token.updated","taxer.tax.calculated","alt_gate.recurring_token.cancelled"]}},"components/schemas/RequestWebhooksEndpointCreate":{"id":"components/schemas/RequestWebhooksEndpointCreate","kind":"json-schema","title":"RequestWebhookEndpointCreate","data":{"title":"RequestWebhookEndpointCreate","type":"object","required":["url","event_types"],"properties":{"url":{"type":"string","description":"URL for webhook event delivery.","maxLength":512},"event_types":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#manage-webhooks","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the webhook endpoint is subscribed to."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SchemaWebhooksEventType"}},"name":{"type":"string","description":"Field for storing the webhook configuration name.","maxLength":255},"status":{"$ref":"#/components/schemas/SchemaWebhooksStatus"}}}},"components/schemas/ResponseWebhooksEndpointAlreadyExists":{"id":"components/schemas/ResponseWebhooksEndpointAlreadyExists","kind":"json-schema","title":"Endpoint exists","data":{"title":"Endpoint exists","type":"object","properties":{"error":{"type":"object","description":"Error object.","properties":{"code":{"type":"string","description":"Error code."},"message":{"type":"string","description":"Error message."}},"required":["code","message"]}},"required":["error"]}},"components/schemas/RequestWebhooksEndpointUpdate":{"id":"components/schemas/RequestWebhooksEndpointUpdate","kind":"json-schema","title":"RequestWebhookEndpointUpdate","data":{"title":"RequestWebhookEndpointUpdate","type":"object","properties":{"event_types":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#manage-webhooks","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the webhook endpoint is subscribed to."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SchemaWebhooksEventType"}},"name":{"type":"string","description":"Field for storing the webhook configuration name.","maxLength":255},"url":{"type":"string","description":"URL for webhook event delivery.","maxLength":512},"status":{"$ref":"#/components/schemas/SchemaWebhooksStatus"}}}},"components/schemas/ResponseWebhooksEndpointNotFound":{"id":"components/schemas/ResponseWebhooksEndpointNotFound","kind":"json-schema","title":"Endpoint not found","data":{"title":"Endpoint not found","type":"object","properties":{"error":{"type":"object","description":"Error object.","properties":{"code":{"type":"string","description":"Error code."},"message":{"type":"string","description":"Error message."}},"required":["code","message"]}},"required":["error"]}},"components/schemas/HeaderMainMerchantWebhook":{"id":"components/schemas/HeaderMainMerchantWebhook","kind":"json-schema","title":"HeaderMainMerchantWebhook","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#security","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided upon registration and must be shared for identification purposes."},"children":[]}]}]}],"example":"wh_pk_7b197...ba108f842"}},"components/schemas/RequestCardsWebhookOrderStatus":{"id":"components/schemas/RequestCardsWebhookOrderStatus","kind":"json-schema","title":"RequestWebhookCardsOrderStatus","data":{"title":"RequestWebhookCardsOrderStatus","type":"object","properties":{"order":{"type":"object","description":"Information about the order, including identifiers, timestamps, amounts, status, and customer details.","properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255,"example":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55"},"order_description":{"type":"string","description":"Brief description of the order.","maxLength":255,"example":"Premium package"},"psp_order_id":{"type":"string","description":"PSP identifier generated by Solidgate."},"provider_payment_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PSP identifier generated by the PSP."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Value will be if the integration transmitted this data."},"children":[]}]}]}]},"product_id":{"type":"string","format":"uuid","maxLength":36,"minLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}]},"product_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"minLength":1,"maxLength":500},"subscription_id":{"type":"string","description":"Unique subscription identifier.","format":"uuid","maxLength":36,"minLength":36,"example":"83b19018-cbc4-4df0-899a-dda84fd2705e"},"invoice_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique invoice identifier associated with the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Retrieve invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/v2/invoices","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invoices"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" API V2."},"children":[]}]}]}],"maxLength":100,"example":"inv_01KPWT0K1PQWEYYRT7J1H3NC85"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This is the intended initial authorization amount."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]}]}],"example":100},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3,"example":"USD"},"processing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of the payment in the smallest currency unit as it was processed by the payment service provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This amount may differ from the original order amount due to currency conversion or other processing factors."},"children":[]}]}]}]},"processing_currency":{"type":"string","minLength":3,"maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the payment when it was processed by payment service provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In some cases, it is different from the original currency."},"children":[]}]}]}]},"marketing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This is based on the intended initial authorization amount."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It should not be considered financial information, but it can be used for forecasting."},"children":[]}]}]}]},"marketing_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the currency used for calculation of marketing amount."},"children":[]}]}]}],"example":"USD"},"refunded_amount":{"type":"integer","description":"Indicates the amount that has been already refunded."},"authorized_amount":{"type":"integer","description":"Total authorized amount of the order."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In the case of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"error"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object will be returned at the order level."},"children":[]}]}]}],"enum":["processing","3ds_verify","refunded","auth_ok","auth_failed","settle_ok","partial_settled","void_ok"],"example":"processing"},"auth_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction authorization code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It can be empty if the provider does not pass a value."},"children":[]}]}]}],"example":"2w9m8"},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided."},"children":[]}]}]}],"enum":["1-click","recurring","retry","installment","rebill","moto"]},"payment_method":{"type":"string","description":"Payment method used for the transaction.","enum":["card","network-token","token","apple-pay","google-pay"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100,"example":"93a1c659-288d-4d62-929d-10e241078faa"},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100,"example":"example@example.com"},"descriptor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying text that appears on a customer’s credit or debit card statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It includes information about the transaction and helps the cardholder recognize the charge."},"children":[]}]}]}],"example":"google.com"},"mid":{"type":"string","description":"Merchant identifier in Solidgate.","example":"bank-mid-1"},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"traffic_source":{"type":"string","description":"Identifies the marketing or acquisition channel that brought the customer to the transaction.","maxLength":255,"example":"facebook"},"fraudulent":{"type":"boolean","description":"Whether the merchant system has flagged this customer as suspicious.","deprecated":true,"default":false}}},"error":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Returned only in cases of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status at the order, and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"fail"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status at transaction."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/SchemaCardsDiscriminatorErrorSuccess"}]},"transaction":{"description":"Details of a card transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.","properties":{"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the transaction was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the transaction."},"children":[]}]}]}],"maxLength":3,"minLength":3},"marketing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It should not be considered financial information, but it can be used for forecasting."},"children":[]}]}]}]},"marketing_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the currency used for calculation of marketing amount."},"children":[]}]}]}],"example":"USD"},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["recurring-auth","refund","resign-auth","auth","settle","void","apple-pay","google-pay"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In the case of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"fail"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"error"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object will be returned at the transaction level."},"children":[]}]}]}],"enum":["processing","success","fail","verify"]},"authorization_type":{"type":"string","enum":["final","estimated","incremental"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"scheme_transaction_id":{"type":"string","description":"Card-scheme transaction identifier linking this transaction to the original customer-initiated payment."},"transaction_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Link Identifier ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is an ID generated by Mastercard to link lifecycle activity after the original transaction."},"children":[]}]}]}],"maxLength":255},"descriptor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying text that appears on a customer’s credit or debit card statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It includes information about the transaction and helps the cardholder recognize the charge."},"children":[]}]}]}]},"billing_details":{"$ref":"#/components/schemas/SchemaCardsBillingDetails"},"refund_reason":{"type":"string","description":"Text description of the refund reason."},"refund_reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code representing the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/refund-reasons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reason"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This code is used to identify the reason for both "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" transactions "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"operation"},"children":[]}]}]}]}],"minLength":4,"maxLength":4},"card_token":{"title":"CardTokenModel","type":"object","description":"Token associated with a card method that can be used for subsequent payments.","properties":{"token":{"type":"string","description":"Token generated for a card method, enabling its use for future payments."},"original_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method used to capture the card credentials at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}],"enum":["card","apple-pay","google-pay","network-token","click-to-pay"],"example":"card"}}},"card":{"description":"Object containing detailed information about the card used in the transaction.","type":"object","properties":{"bank":{"type":"string","description":"Name of the card issuer."},"bin":{"type":"string","minLength":6,"maxLength":6,"description":"Card issuer Bank Identification Number (BIN)."},"brand":{"type":"string","description":"Card brand."},"card_exp_month":{"type":"string","description":"Expiry month of the card.","minLength":2,"maxLength":2},"card_exp_year":{"type":"integer","description":"Expiry year of the card."},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$","example":"John Snow"},"card_type":{"type":"string","description":"Card type.","enum":["CREDIT","CREDIT/DEBIT","DEBIT","PREPAID","CHARGE CARD","DEFERRED DEBIT"]},"card_category":{"type":"string","description":"Card category.","enum":["ANONYMOUS PREPAID","COMMERCIAL DEBIT","CONSUMER DEBIT","PREPAID","PREPAID RELOADABLE","SMALL BUSINESS","BUSINESS","COMMERCIAL","GOVERNMENT NOTES","PAYOUTS","CONSUMER","CORPORATE"]},"is_reloadable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#reloadable-prepaid-indicator","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of whether the card belongs to a reloadable program."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" means the reloadable indicator is not available."},"children":[]}]}]}]},"card_id":{"type":"string","description":"Unique identifier of the card used for the transaction.","format":"uuid"},"country":{"type":"string","description":"Card issuer country.","format":"iso_code_a3","maxLength":3,"minLength":3},"number":{"type":"string","description":"Masked card number.","maxLength":19},"card_token":{"title":"CardTokenModel","type":"object","description":"Token associated with a card method that can be used for subsequent payments.","properties":{"token":{"type":"string","description":"Token generated for a card method, enabling its use for future payments."},"original_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method used to capture the card credentials at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}],"enum":["card","apple-pay","google-pay","network-token","click-to-pay"],"example":"card"}}}}},"error":{"$ref":"#/components/schemas/SchemaCardsDiscriminatorErrorSuccess"},"payment_account_reference":{"type":"string","description":"Payment Account Reference (PAR) is a unique, non-financial identifier for a payment account that remains consistent across card replacements.","example":"PAR_1A2B3C4D5E6F7G8H9"},"arn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acquirer Reference Number (ARN) assigned to transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use ARN to check transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"example":"12345678901234567890123"},"rrn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieval Reference Number (RRN) assigned to transactions, based on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8583","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8583"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standard."},"children":[]}]}]}],"minLength":12,"maxLength":12,"example":"100034876543"}}},"transactions":{"type":"object","description":"Map of transactions where the keys are transaction identifiers.","properties":{"<transaction_id_value_#1>":{"description":"Details of a card transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.","properties":{"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the transaction was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the transaction."},"children":[]}]}]}],"maxLength":3,"minLength":3},"marketing_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It should not be considered financial information, but it can be used for forecasting."},"children":[]}]}]}]},"marketing_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the currency used for calculation of marketing amount."},"children":[]}]}]}],"example":"USD"},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["recurring-auth","refund","resign-auth","auth","settle","void","apple-pay","google-pay"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"In the case of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"fail"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"error"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" object will be returned at the transaction level."},"children":[]}]}]}],"enum":["processing","success","fail","verify"]},"authorization_type":{"type":"string","enum":["final","estimated","incremental"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that defines the transaction flow and capabilities."},"children":[]}]}]}]},"scheme_transaction_id":{"type":"string","description":"Card-scheme transaction identifier linking this transaction to the original customer-initiated payment."},"transaction_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Link Identifier ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is an ID generated by Mastercard to link lifecycle activity after the original transaction."},"children":[]}]}]}],"maxLength":255},"descriptor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying text that appears on a customer’s credit or debit card statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It includes information about the transaction and helps the cardholder recognize the charge."},"children":[]}]}]}]},"billing_details":{"$ref":"#/components/schemas/SchemaCardsBillingDetails"},"refund_reason":{"type":"string","description":"Text description of the refund reason."},"refund_reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code representing the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/refund-reasons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reason"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This code is used to identify the reason for both "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" transactions "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"operation"},"children":[]}]}]}]}],"minLength":4,"maxLength":4},"card_token":{"title":"CardTokenModel","type":"object","description":"Token associated with a card method that can be used for subsequent payments.","properties":{"token":{"type":"string","description":"Token generated for a card method, enabling its use for future payments."},"original_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method used to capture the card credentials at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}],"enum":["card","apple-pay","google-pay","network-token","click-to-pay"],"example":"card"}}},"card":{"description":"Object containing detailed information about the card used in the transaction.","type":"object","properties":{"bank":{"type":"string","description":"Name of the card issuer."},"bin":{"type":"string","minLength":6,"maxLength":6,"description":"Card issuer Bank Identification Number (BIN)."},"brand":{"type":"string","description":"Card brand."},"card_exp_month":{"type":"string","description":"Expiry month of the card.","minLength":2,"maxLength":2},"card_exp_year":{"type":"integer","description":"Expiry year of the card."},"card_holder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's name as it appears on the card, which is essential for transaction processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #D1E6DF"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Should be provided"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow."},"children":[]}]}]}],"minLength":2,"maxLength":52,"pattern":"^\\w.{0,50}[\\w.]$","example":"John Snow"},"card_type":{"type":"string","description":"Card type.","enum":["CREDIT","CREDIT/DEBIT","DEBIT","PREPAID","CHARGE CARD","DEFERRED DEBIT"]},"card_category":{"type":"string","description":"Card category.","enum":["ANONYMOUS PREPAID","COMMERCIAL DEBIT","CONSUMER DEBIT","PREPAID","PREPAID RELOADABLE","SMALL BUSINESS","BUSINESS","COMMERCIAL","GOVERNMENT NOTES","PAYOUTS","CONSUMER","CORPORATE"]},"is_reloadable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#reloadable-prepaid-indicator","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of whether the card belongs to a reloadable program."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" means the reloadable indicator is not available."},"children":[]}]}]}]},"card_id":{"type":"string","description":"Unique identifier of the card used for the transaction.","format":"uuid"},"country":{"type":"string","description":"Card issuer country.","format":"iso_code_a3","maxLength":3,"minLength":3},"number":{"type":"string","description":"Masked card number.","maxLength":19},"card_token":{"title":"CardTokenModel","type":"object","description":"Token associated with a card method that can be used for subsequent payments.","properties":{"token":{"type":"string","description":"Token generated for a card method, enabling its use for future payments."},"original_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method used to capture the card credentials at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/token-usage/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}],"enum":["card","apple-pay","google-pay","network-token","click-to-pay"],"example":"card"}}}}},"error":{"$ref":"#/components/schemas/SchemaCardsDiscriminatorErrorSuccess"},"payment_account_reference":{"type":"string","description":"Payment Account Reference (PAR) is a unique, non-financial identifier for a payment account that remains consistent across card replacements.","example":"PAR_1A2B3C4D5E6F7G8H9"},"arn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acquirer Reference Number (ARN) assigned to transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use ARN to check transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"example":"12345678901234567890123"},"rrn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieval Reference Number (RRN) assigned to transactions, based on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8583","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8583"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standard."},"children":[]}]}]}],"minLength":12,"maxLength":12,"example":"100034876543"}}}}},"three_ds":{"$ref":"#/components/schemas/SchemaCardsThreeDs"},"routing":{"$ref":"#/components/schemas/SchemaCardsRouting"},"antifraud_result":{"$ref":"#/components/schemas/SchemaCardsAntifraudResult"},"verification_result":{"$ref":"#/components/schemas/SchemaCardsVerificationResult"},"chargebacks":{"type":"object","description":"Map of chargebacks where the keys are chargeback identifiers.","properties":{"id":{"type":"integer","description":"Unique chargeback identifier."},"dispute_date":{"type":"string","description":"Date on which the chargeback was created by the issuer.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$ || ^\\d{4}-\\d{2}-\\d{2}"},"settlement_date":{"type":"string","description":"Date on which the chargeback was financially settled.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount that will be deducted for the chargeback on a specific order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This amount may vary based on the user's decision to dispute a different amount."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the chargeback amount."},"children":[]}]}]}],"maxLength":3,"minLength":3},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#types","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback."},"children":[]}]}]}],"enum":["1st_chb","2nd_chb","arbitration"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback."},"children":[]}]}]}],"enum":["in_progress","document_sent","reversed","accepted","resolved","resolved_reversal"]},"reason_group":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/reason-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" group."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It could be used for the segmentation and analytic purposes."},"children":[]}]}]}]},"reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/reason-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the chargeback provided by the card scheme."},"children":[]}]}]}]},"reason_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/reason-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" description for the chargeback provided by the card scheme."},"children":[]}]}]}]},"chargeback_flow":{"type":"array","description":"Map of chargeback flows where the keys are chargeback flow identifiers.","items":{"properties":{"id":{"type":"integer","description":"Unique chargeback flow identifier."},"date":{"type":"string","description":"Datetime when the chargeback flow was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_date":{"type":"string","description":"Datetime when the chargeback flow was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"settlement_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Date when the chargeback flow was financially settled."},"deadline_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deadline for submitting a response to the dispute."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This corresponds to date + n, where n is a number of calendar days set by the scheme/acquirer."},"children":[]}]}]}]},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount involved in each stage of the chargeback process."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For example, there could be two records in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"chargeback_flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" one with an amount of 113.58 USD and another with an amount of 100 USD."},"children":[]}]}]}]},"dispute_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific amount disputed, typically in the smallest currency unit, that would be returned to the merchant if the dispute is resolved in their favor."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For example, if the second chargeback was successfully disputed, the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"dispute_amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" would be 100 USD."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the chargeback amount."},"children":[]}]}]}],"minLength":3,"maxLength":3},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#types","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback flow."},"children":[]}]}]}],"enum":["1st_chb","2nd_chb","arbitration"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback."},"children":[]}]}]}],"enum":["in_progress","document_sent","reversed","accepted","resolved","resolved_reversal"]},"arn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acquirer Reference Number (ARN) assigned to transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use ARN to check transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"rrn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieval Reference Number (RRN) assigned to transactions, based on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8583","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8583"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standard."},"children":[]}]}]}],"minLength":12,"maxLength":12}}}}}},"device_info":{"description":"Information about the device used.","allOf":[{"$ref":"#/components/schemas/SchemaCardsDeviceInfo"}]},"verify_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the customer should be redirected to complete 3DS authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Only after opening the URL and authenticating the order "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" change to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"redirect_url":{"type":"string","description":"URL where customer should be redirected after finishing 3D Secure or redirect payment method."},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"payment_adviser":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SchemaCardsPaymentAdviser"}]}}}},"components/schemas/RequestCardsWebhookNetworkTokenCreated":{"id":"components/schemas/RequestCardsWebhookNetworkTokenCreated","kind":"json-schema","title":"RequestWebhookCardsNetworkTokenCreated","data":{"title":"RequestWebhookCardsNetworkTokenCreated","type":"object","properties":{"card_id":{"type":"string","format":"uuid","description":"Unique card identifier provided by merchant in the payment request."},"tokenization_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/card-schemes-tokenization/#tokenization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of tokenization associated with the card, a process that replaces the card's primary account number (PAN) with a unique digital token to ensure secure transactions."},"children":[]}]}]}],"enum":["vts","mdes","scof"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Network token "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/card-schemes-tokenization/#tokenization-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["INACTIVE","ACTIVE","SUSPENDED","DEACTIVATED","DELETED"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Network token creation date."},"updated_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Date of network token status update."}}}},"components/schemas/RequestCardsWebhookNetworkTokenUpdated":{"id":"components/schemas/RequestCardsWebhookNetworkTokenUpdated","kind":"json-schema","title":"RequestWebhookCardsNetworkTokenUpdated","data":{"title":"RequestWebhookCardsNetworkTokenUpdated","type":"object","properties":{"card_id":{"type":"string","format":"uuid","description":"Unique card identifier provided by merchant in the payment request."},"tokenization_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/card-schemes-tokenization/#tokenization-type","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of tokenization associated with the card, a process that replaces the card's primary account number (PAN) with a unique digital token to ensure secure transactions."},"children":[]}]}]}],"enum":["vts","mdes","scof"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Network token "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/card-schemes-tokenization/#tokenization-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["INACTIVE","ACTIVE","SUSPENDED","DEACTIVATED","DELETED"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Network token creation date."},"updated_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Date of network token status update."}}}},"components/schemas/RequestCardsWebhookChargeback":{"id":"components/schemas/RequestCardsWebhookChargeback","kind":"json-schema","title":"RequestWebhookCardsChargeback","data":{"title":"RequestWebhookCardsChargeback","type":"object","properties":{"order":{"type":"object","description":"Information about the order, including identifiers, timestamps, amounts, status, and customer details.","properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["processing","3ds_verify","refunded","auth_ok","auth_failed","settle_ok","partial_settled","void_ok"]}}},"chargeback":{"type":"object","description":"Map of chargebacks where the keys are chargeback identifiers.","properties":{"id":{"type":"integer","description":"Unique chargeback identifier."},"dispute_date":{"type":"string","description":"Date on which the chargeback was created by the issuer.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"settlement_date":{"type":"string","description":"Date on which the chargeback was financially settled.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount that will be deducted for the chargeback on a specific order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This amount may vary based on the user's decision to dispute a different amount."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the chargeback amount."},"children":[]}]}]}],"maxLength":3,"minLength":3},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#types","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback."},"children":[]}]}]}],"enum":["1st_chb","2nd_chb","arbitration"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback."},"children":[]}]}]}],"enum":["in_progress","document_sent","reversed","accepted","resolved","resolved_reversal"]},"reason_group":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/reason-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" group."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It could be used for the segmentation and analytic purposes."},"children":[]}]}]}]},"reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/reason-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the chargeback provided by the card scheme."},"children":[]}]}]}]},"reason_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/reason-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" description for the chargeback provided by the card scheme."},"children":[]}]}]}]},"available_actions":{"type":"array","description":"List of available actions for the chargeback in the current state.","items":{"type":"string","enum":["enrich_evidence","provide_evidence"]}}}},"chargeback_flow":{"type":"array","description":"Map of chargeback flows where the keys are chargeback flow identifiers.","items":{"properties":{"id":{"type":"integer","description":"Unique chargeback flow identifier."},"date":{"type":"string","description":"Datetime when the chargeback flow was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_date":{"type":"string","description":"Datetime when the chargeback flow was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"settlement_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Date on which the chargeback flow was financially settled."},"deadline_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deadline for submitting a response to the dispute."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This corresponds to date + n, where n is a number of calendar days set by the scheme/acquirer."},"children":[]}]}]}]},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount involved in each stage of the chargeback process."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For example, there could be two records in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"chargeback_flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" one with an amount of 113.58 USD and another with an amount of 100 USD."},"children":[]}]}]}]},"dispute_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific amount disputed, typically in the smallest currency unit, that would be returned to the merchant if the dispute is resolved in their favor."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For example, if the second chargeback was successfully disputed, the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"dispute_amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" would be 100 USD."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code  of the chargeback amount."},"children":[]}]}]}],"minLength":3,"maxLength":3},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#types","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback flow."},"children":[]}]}]}],"enum":["1st_chb","2nd_chb","arbitration"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chargeback."},"children":[]}]}]}],"enum":["in_progress","document_sent","reversed","accepted","resolved","resolved_reversal"]},"represented_by":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates which party has provided the defense document for dispute "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/chargebacks/#respond-to-chargebacks","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"representment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["merchant","automation"]},"arn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acquirer Reference Number (ARN) assigned to transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use ARN to check transaction "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"rrn_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieval Reference Number (RRN) assigned to transactions, based on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_8583","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8583"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standard."},"children":[]}]}]}],"minLength":12,"maxLength":12}}}}}}},"components/schemas/RequestCardsWebhookPreventAlert":{"id":"components/schemas/RequestCardsWebhookPreventAlert","kind":"json-schema","title":"RequestWebhookCardsPreventAlert","data":{"title":"RequestWebhookCardsPreventAlert","type":"object","properties":{"order":{"type":"object","description":"Information about the order, including identifiers, timestamps, amounts, status, and customer details.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["processing","settle_pending","approved","declined","refunded"]}}},"alert":{"type":"object","description":"Information about chargeback alerts, including identifiers, amounts, currency, provider details, alert types, and outcomes.","properties":{"id":{"type":"string","description":"Unique identifier assigned to each alert.","maxLength":100},"amount":{"type":"integer","description":"Amount specified in the alert."},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}]},"provider_name":{"type":"string","description":"Name of provider that sent alerts.","enum":["ethoca","verifi"]},"alert_date":{"type":"string","description":"Datetime when the alert was raised on the provider's side.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"created_at":{"type":"string","description":"Datetime when the alert was created in the system.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the alert was updated in the system.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"alert_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/prevention-alerts/insights/#alert-types","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of alert."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Each alert type denotes a specific event or action in the chargeback flow."},"children":[]}]}]}],"enum":["inquiry","init-refund","resolved","prevented"]},"outcome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific response "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/prevention-alerts/insights/#alert-outcome","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for webhook alerts."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Upon receiving a webhook alert, the primary task is to promptly provide a valid response using one of the specified outcomes. Only the initial response to the alert is accepted, with the exception when the initial status was set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Once a response is submitted to the provider, subsequent modifications are not permitted."},"children":[]}]}]}],"enum":["reversed","previously-reversed","duplicate","decline","error","reverse-error","not-found","acknowledged","pending","shipped"]}}}}}},"components/schemas/RequestCardsWebhookFraudAlert":{"id":"components/schemas/RequestCardsWebhookFraudAlert","kind":"json-schema","title":"RequestCardsWebhookFraudAlert","data":{"title":"RequestCardsWebhookFraudAlert","type":"object","properties":{"id":{"type":"integer","description":"Unique fraud alert identifier."},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"created_at":{"type":"string","description":"Datetime when the fraud alert was created by Solidgate.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the fraud alert was updated by Solidgate.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"fraud_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fraud amount in the smallest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]}]}]},"fraud_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}]},"fraud_amount_usd":{"type":"integer","description":"Amount converted to USD, used for standardized reporting and analysis across different currencies."},"fraud_report_day":{"type":"string","description":"Date on which the fraud was reported."},"fraud_type":{"type":"string","description":"Type of fraud detected, categorizing the nature of the fraudulent activity."},"card_scheme":{"type":"string","description":"Card scheme associated with the transaction (e.g., Visa, Mastercard), providing context on the payment network involved."},"reason_code_description":{"type":"string","description":"Detailed explanation of the reason code associated with the fraud alert, offering insights into why the fraud was flagged."}}}},"components/schemas/RequestBillingWebhookTaxCalculated":{"id":"components/schemas/RequestBillingWebhookTaxCalculated","kind":"json-schema","title":"RequestFinancesWebhookTaxCalculated","data":{"title":"RequestFinancesWebhookTaxCalculated","type":"object","properties":{"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255,"example":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55"},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Can be absent for payments without "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"maxLength":36,"format":"uuid"},"total_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment total amount in the smallest currency unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is negative if the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"action"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"sale"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"chargeback_reversed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rdr_reversed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency used to initiate the payment by the merchant. Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"maxLength":3,"minLength":3},"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/taxes/tax-insights/#tax-actions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a transaction involving tax calculation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For all "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"action"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" types except "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"sale"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"chargeback_reversed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rdr_reversed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the calculation amounts will be negative."},"children":[]}]}]}],"enum":["sale","refund","chargeback","rdr","chargeback_reversed","rdr_reversed","paypal_dispute"]},"payment_category":{"type":"string","description":"Payment method used to process the payment.","enum":["card-payment","apm-payment"]},"transaction_date":{"type":"string","description":"Datetime when the payment was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"tax_included":{"type":"boolean","description":"Indicates type of the tax."},"tax":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information related to the tax calculation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent if the tax calculation fails."},"children":[]}]}]}],"properties":{"tax_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of the tax calculated."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is negative if the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"action"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"sale"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"chargeback_reversed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rdr_reversed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"taxable_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Taxable amount of the transaction before tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is negative if the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"action"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"sale"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"chargeback_reversed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"rdr_reversed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"rate":{"type":"number","format":"decimal","description":"Tax rate used for the tax calculation."},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency in which the tax was calculated. Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Some locations only accept tax in their native currency."},"children":[]}]}]}],"maxLength":3,"minLength":3},"location":{"type":"object","description":"Information about the cardholder's location.","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code where the tax applies, specified using an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code."},"children":[]}]}]}],"format":"iso_code_a3","minLength":3,"maxLength":3},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the tax jurisdiction state."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is filled if the country is the USA. Otherwise, it is absent."},"children":[]}]}]}]}}},"legal_entity":{"type":"string","description":"Name of the Legal entity for tax submission."}}},"no_tax_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for no tax calculated."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent if the tax calculation is successful."},"children":[]}]}]}]}}}},"components/schemas/RequestApmWebhookOrderStatus":{"id":"components/schemas/RequestApmWebhookOrderStatus","kind":"json-schema","title":"RequestApmWebhookOrderStatus","data":{"title":"RequestApmWebhookOrderStatus","type":"object","properties":{"order":{"type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}]},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"subscription_id":{"type":"string","description":"Unique subscription identifier.","format":"uuid","maxLength":36,"minLength":36},"token":{"type":"string","description":"Token associated with a card method that can be used for the subsequent payments."},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the order was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"order_description":{"type":"string","description":"Brief order description.","maxLength":100},"descriptor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying text that appears on a customer’s statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It includes information about the transaction and helps the customer recognize the charge and provided only for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","settle_pending","approved","declined","refunded"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100},"ip_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public IP address of the cardholder, both IPv4 and IPv6 are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Useful for antifraud checks. For recurring payments, use the last session or registration IP."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"'Invalid IP'"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" error."},"children":[]}]}]}],"maxLength":50},"provider_data":{"$ref":"#/components/schemas/SchemaApmProviderData"}}},"error":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Returned only in cases of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses at the order, and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"fail"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status at transaction."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/SchemaApmDiscriminatorErrorSuccess"}]},"transactions":{"type":"array","description":"Details of transactions, including identifiers, amounts, currencies, statuses, and types.","items":{"type":"object","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to process the order."},"children":[]}]}]}]},"id":{"type":"string","description":"Unique transaction identifier.","maxLength":100},"created_at":{"type":"string","description":"Datetime when the transaction was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by the alternative payment method."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"maxLength":3,"minLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["created","processing","settle_pending","success","fail"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","refund"]},"refund_reason":{"type":"string","description":"Text description of the refund reason."},"refund_reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund reason "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/refund-reasons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field is actively validated against the current list of reason codes. Deprecated codes will not be accepted."},"children":[]}]}]}],"minLength":4,"maxLength":4},"payer_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information such as the payer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","deprecated":true,"properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal.","example":"123443334","deprecated":true},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It would be provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}],"deprecated":true}}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an order.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10},"pay_form":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment form data."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Including fields necessary for processing the payment."},"children":[]}]}]}],"properties":{"token":{"type":"string","description":"Secure payment token representing sensitive payment method information.","deprecated":true},"script_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the JavaScript file needed to display the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/payment-form/apm-buttons/#method-specific-configuration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal button"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for integration, initialization, configuration."},"children":[]}]}]}],"maxLength":255,"deprecated":true}},"deprecated":true}}}},"components/schemas/RequestApmWebhookPaypalDispute":{"id":"components/schemas/RequestApmWebhookPaypalDispute","kind":"json-schema","title":"RequestWebhookPaypalDispute","data":{"title":"RequestWebhookPaypalDispute","type":"object","properties":{"dispute_id":{"type":"string","description":"Unique dispute identifier."},"order_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"subscription_product_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It corresponds to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"product_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" parameter in subscriptions."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"subscription_service_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique subscription identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It corresponds to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"subscription_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" parameter in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/manage-subscriptions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"format":"uuid","maxLength":36,"minLength":36},"created_at":{"type":"string","description":"Datetime when the dispute was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the dispute was updated.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"seller_response_due_date":{"type":"string","description":"Deadline for submitting a response to the dispute."},"dispute_amount":{"type":"integer","description":"Dispute amount."},"dispute_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the dispute."},"children":[]}]}]}],"minLength":3,"maxLength":3},"dispute_life_cycle_stage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stage in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/insights/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispute lifecycle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["INQUIRY","CHARGEBACK","PRE_ARBITRATION","ARBITRATION"]},"dispute_channel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/insights/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"channel"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by which PayPal dispute has been received."},"children":[]}]}]}],"enum":["INTERNAL","EXTERNAL","ALERT"]},"dispute_create_time":{"type":"string","description":"Datetime when the dispute was created."},"dispute_update_time":{"type":"string","description":"Datetime when the dispute was updated."},"dispute_outcome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/insights/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outcome"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the dispute."},"children":[]}]}]}],"enum":["RESOLVED_BUYER_FAVOUR","RESOLVED_SELLER_FAVOUR","RESOLVED_WITH_PAYOUT","CANCELED_BY_BUYER","NONE"]},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/insights/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the received dispute."},"children":[]}]}]}],"enum":["MERCHANDISE_OR_SERVICE_NOT_RECEIVED","MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED","UNAUTHORISED","CREDIT_NOT_PROCESSED","DUPLICATE_TRANSACTION","INCORRECT_AMOUNT","PAYMENT_BY_OTHER_MEANS","CANCELED_RECURRING_BILLING","PROBLEM_WITH_REMITTANCE","OTHER"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/insights/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the PayPal dispute."},"children":[]}]}]}],"enum":["OPEN","WAITING_FOR_BUYER_RESPONSE","WAITING_FOR_SELLER_RESPONSE","UNDER_REVIEW","RESOLVED","OTHER"]},"represented_by":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates which party has provided the defense document for dispute "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/paypal-risk-metrics/manage/#dispute-representment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"representment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["merchant","automation"]},"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address."},"available_actions":{"type":"array","description":"List of available actions for the dispute in the current state.","items":{"type":"string","enum":["enrich_evidence","provide_evidence"]}}}}},"components/schemas/RequestApmWebhookPreventAlert":{"id":"components/schemas/RequestApmWebhookPreventAlert","kind":"json-schema","title":"RequestWebhookCardsPreventAlert","data":{"title":"RequestWebhookCardsPreventAlert","type":"object","properties":{"order":{"type":"object","description":"Details of an order, including identifiers, timestamps, amounts, status, and customer data.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"created_at":{"type":"string","description":"Datetime when the order was created.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order amount in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/supported-currencies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"smallest currency unit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (cents for euros)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For instance, 1020 means 10 EUR and 20 cents."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}],"minLength":3,"maxLength":3},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested order."},"children":[]}]}]}],"enum":["created","processing","settle_pending","approved","declined","refunded"]}}},"alert":{"type":"object","description":"Details about chargeback alerts, including identifiers, amounts, currency, provider data, alert types, and outcomes.","properties":{"id":{"type":"string","description":"Unique identifier assigned to each alert.","maxLength":100},"amount":{"type":"integer","description":"Amount specified in the alert."},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}]},"provider_name":{"type":"string","description":"Name of the alert provider.","enum":["ethoca","verifi"]},"alert_date":{"type":"string","description":"Datetime when the alert was raised on the provider's side.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"created_at":{"type":"string","description":"Datetime when the alert was created in the system.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime when the alert was updated in the system.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"alert_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/prevention-alerts/insights/#alert-types","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of alert."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Each alert type denotes a specific event or action in the chargeback flow."},"children":[]}]}]}],"enum":["inquiry","resolved"]},"outcome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific response "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/risks/prevention-alerts/insights/#alert-outcome","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for webhook alerts."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Upon receiving a webhook alert, the primary task is to promptly provide a valid response using one of the specified outcomes. Only the initial response to the alert is accepted, with the exception when the initial status was set to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Once a response is submitted to the provider, subsequent modifications are not permitted."},"children":[]}]}]}],"enum":["reversed","previously-reversed","duplicate","decline","error","reverse-error","not-found","acknowledged","pending","shipped"]}}}}}},"components/schemas/RequestApmWebhookRevokedRecurringToken":{"id":"components/schemas/RequestApmWebhookRevokedRecurringToken","kind":"json-schema","title":"RequestApmWebhookRevokedRecurringToken","data":{"title":"RequestApmWebhookRevokedRecurringToken","type":"object","required":["token","initial_order_id","cancelled_at"],"properties":{"token":{"type":"string","description":"Recurring token.","example":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55"},"initial_order_id":{"type":"string","description":"Initial order identifier.","maxLength":255,"example":"22738n"},"cancelled_at":{"type":"string","description":"Datetime when the token was cancelled.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2024-12-21 11:21:30"}}}},"components/schemas/SchemaBillingSubscriptionWebhookProduct":{"id":"components/schemas/SchemaBillingSubscriptionWebhookProduct","kind":"json-schema","title":"SchemaBillingSubscriptionWebhookProduct","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription product details, including name, pricing logic, amount, currency, trial settings, and other related attributes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The list of fields within the object differs from the field set during the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/products-and-prices/create-product","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"creation of the product"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" request."},"children":[]}]}]}],"properties":{"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"minLength":36,"maxLength":36,"format":"uuid"},"name":{"type":"string","description":"Product name."},"payment_action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-overview/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied to the first transaction, with or without the next money return, for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"free trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment actions are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_0_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_void"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the last indicating that the funds will be refunded to the customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid trial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if product has a trial."},"children":[]}]}]}],"enum":["auth_0_amount","auth_void","auth_settle"]},"amount":{"description":"Product price.","type":"integer"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the product price currency."},"children":[]}]}]}],"maxLength":3,"minLength":3},"trial":{"type":"boolean","description":"Indicates whether the product has a trial."},"trial_period":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the trial period in minutes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if the product has a trial."},"children":[]}]}]}]},"trial_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trial price."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if product has a trial."},"children":[]}]}]}]},"trial_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the trial price currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{"style":{"borderLeft":"4px solid #F2C4C4"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" if product has a trial."},"children":[]}]}]}],"maxLength":3,"minLength":3}},"required":["product_id","name","amount","currency","trial"]}},"components/schemas/SchemaBillingSubscriptionWebhookCustomer":{"id":"components/schemas/SchemaBillingSubscriptionWebhookCustomer","kind":"json-schema","title":"SchemaBillingSubscriptionWebhookCustomer","data":{"type":"object","description":"Customer details related to the subscription, including key information such as the customer's email address.","properties":{"customer_account_id":{"type":"string","description":"Unique customer identifier defined by the merchant.","maxLength":100},"customer_email":{"type":"string","description":"Customer's email address.","maxLength":100}},"required":["customer_account_id","customer_email"]}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedCreate":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedCreate","kind":"json-schema","title":"WebhookSubscriptionCreate","data":{"title":"WebhookSubscriptionCreate","type":"object","required":["callback_type","subscription","product","customer"],"properties":{"callback_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription event type, representing a specific change in the subscription lifecycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"View parameters specific to a particular callback type by choosing the relevant callback type."},"children":[]}]}]}],"enum":["create"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","updated_at","trial"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pending"]},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["processing"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}],"enum":["processing"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedExpire":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedExpire","kind":"json-schema","title":"WebhookSubscriptionExpire","data":{"title":"WebhookSubscriptionExpire","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["expire"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","updated_at","trial"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["cancelled"]},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedPaymentAttempt":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedPaymentAttempt","kind":"json-schema","title":"WebhookSubscriptionPaymentAttempt","data":{"title":"WebhookSubscriptionPaymentAttempt","type":"object","required":["callback_type","subscription","product","customer"],"properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["payment_attempt"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","updated_at","trial"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pending"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["processing"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}],"enum":["processing"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedActive":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedActive","kind":"json-schema","title":"WebhookSubscriptionActive","data":{"title":"WebhookSubscriptionActive","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["active"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedRenew":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedRenew","kind":"json-schema","title":"WebhookSubscriptionRenew","data":{"title":"WebhookSubscriptionRenew","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["renew"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedSwitchProduct":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedSwitchProduct","kind":"json-schema","title":"WebhookSubscriptionSwitchProduct","data":{"title":"WebhookSubscriptionSwitchProduct","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["switch_product"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"cancellation_requested_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of subscription cancellation request."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Present "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"only"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" when the product is changed after subscription cancellation."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success","fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedUpdateOrder":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedUpdateOrder","kind":"json-schema","title":"WebhookSubscriptionUpdateOrder","data":{"title":"WebhookSubscriptionUpdateOrder","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription event type, representing a specific change in the subscription lifecycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription has multiple invoices, this event is only sent for the most recent invoice at the time the order status changes. Webhooks for orders on older invoices are suppressed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":" To receive events for all order updates regardless of invoice status, "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/integrate/webhooks/#manage-webhooks","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"subscribe"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"card_gate.order.updated"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"alt_gate.order.updated"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"enum":["order_update"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","updated_at","trial"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pending","active","cancelled","redemption","paused","expired"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["processing","retry","success","fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedPause":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedPause","kind":"json-schema","title":"WebhookSubscriptionPause","data":{"title":"WebhookSubscriptionPause","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["pause"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","pause","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["paused"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription pause type value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the datetime is the date and time of the pause start request."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"to_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"}},"required":["from_date"]}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedCreatePauseSchedule":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedCreatePauseSchedule","kind":"json-schema","title":"WebhookSubscriptionCreatePauseSchedule","data":{"title":"WebhookSubscriptionCreatePauseSchedule","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["pause_schedule.create"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","pause","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription pause type value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the datetime is the date and time of the pause start request."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"to_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"}},"required":["from_date"]}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}]},"created_at":{"type":"string","description":"Datetime of the order creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","description":"Datetime of the order creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedUpdatePauseSchedule":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedUpdatePauseSchedule","kind":"json-schema","title":"WebhookSubscriptionUpdatePauseSchedule","data":{"title":"WebhookSubscriptionUpdatePauseSchedule","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["pause_schedule.update"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","pause","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active","paused"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription pause type value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the datetime is the date and time of the pause start request."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"to_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"}},"required":["from_date"]}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedDeletePauseSchedule":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedDeletePauseSchedule","kind":"json-schema","title":"WebhookSubscriptionDeletePauseSchedule","data":{"title":"WebhookSubscriptionDeletePauseSchedule","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["pause_schedule.delete"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["processing","retry","success","fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedResume":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedResume","kind":"json-schema","title":"WebhookSubscriptionResume","data":{"title":"WebhookSubscriptionResume","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["resume"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedRecurring":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedRecurring","kind":"json-schema","title":"WebhookSubscriptionRecurring","data":{"title":"WebhookSubscriptionRecurring","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["recurring"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["processing","retry","success","fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedRestore":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedRestore","kind":"json-schema","title":"WebhookSubscriptionRestore","data":{"title":"WebhookSubscriptionRestore","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["restore"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success","fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedCancel":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedCancel","kind":"json-schema","title":"WebhookSubscriptionCancel","data":{"title":"WebhookSubscriptionCancel","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["cancel"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","cancelled_at","cancellation_requested_at","cancel_code","cancel_message"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["cancelled"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."},"cancelled_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of subscription cancellation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This parameter is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", but in other cases, for example in refunds, this parameter is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"cancellation_requested_at":{"type":"string","description":"Datetime of subscription cancellation request.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"]},"cancel_message":{"type":"string","description":"Cancellation reason."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success","fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedScheduleCancellation":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedScheduleCancellation","kind":"json-schema","title":"WebhookSubscriptionScheduleCancellation","data":{"title":"WebhookSubscriptionScheduleCancellation","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["scheduled_for_cancellation"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","cancelled_at","cancellation_requested_at","cancel_code","cancel_message"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."},"cancelled_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of subscription cancellation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This parameter is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", but in other cases, for example in refunds, this parameter is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"cancellation_requested_at":{"type":"string","description":"Datetime of subscription cancellation request.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"]},"cancel_message":{"type":"string","description":"Cancellation reason."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success","fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedRedemption":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedRedemption","kind":"json-schema","title":"WebhookSubscriptionRedemption","data":{"title":"WebhookSubscriptionRedemption","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["redemption"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["redemption"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the subsequent charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If smart retries are enabled, this field may delay appearing in webhook payloads. Retry the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.solidgate.com/api/retrieve-subscription-data/get-subscription-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"subscription status"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" 5–15 seconds later. In rare cases, the value becomes available within 15 minutes."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["retry"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the transaction. All possible values are described in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedRetry":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedRetry","kind":"json-schema","title":"WebhookSubscriptionRetry","data":{"title":"WebhookSubscriptionRetry","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["retry"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["redemption"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["retry"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the transaction. All possible values are described in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}],"enum":["processing"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the transaction. All possible values are described in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookExtendedScheduleRetry":{"id":"components/schemas/SchemaBillingSubscriptionWebhookExtendedScheduleRetry","kind":"json-schema","title":"WebhookSubscriptionScheduleRetry","data":{"title":"WebhookSubscriptionScheduleRetry","type":"object","required":["callback_type","subscription","product","customer"],"description":"","properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["scheduled_for_retry"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["redemption"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["retry"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"discount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/coupons/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied."},"children":[]}]}]}],"required":["created_at","coupon"],"properties":{"created_at":{"type":"string","description":"Datetime of the discount creation.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-05-31 12:53:12"},"coupon_code":{"type":"string","minLength":2,"maxLength":25,"description":"Coupon code.","example":"SUMMER25OFF"},"coupon":{"type":"object","description":"Coupon details.","required":["name","type","value"],"properties":{"name":{"type":"string","description":"Coupon name.","example":"Summer 25% OFF"},"description":{"type":"string","description":"Coupon description.","example":"25% off for 3 months"},"type":{"type":"string","description":"Discount type indicating percentage or fixed amount off the price.","enum":["percentage","amount"],"example":"percentage"},"value":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Depending on the coupon type, the value represents either a percentage or a fixed amount."},"children":[]}]}]}],"example":25}}}}},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the transaction. All possible values are described in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the transaction. All possible values are described in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionDiscriminatorWebhookExtended":{"id":"components/schemas/SchemaBillingSubscriptionDiscriminatorWebhookExtended","kind":"json-schema","title":"Extended","data":{"title":"Extended","type":"object","discriminator":{"propertyName":"callback_type","mapping":{"create":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedCreate","expire":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedExpire","payment_attempt":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedPaymentAttempt","active":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedActive","renew":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedRenew","switch_product":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedSwitchProduct","order_update":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedUpdateOrder","pause":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedPause","pause_schedule.create":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedCreatePauseSchedule","pause_schedule.update":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedUpdatePauseSchedule","pause_schedule.delete":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedDeletePauseSchedule","resume":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedResume","recurring":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedRecurring","restore":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedRestore","cancel":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedCancel","scheduled_for_cancellation":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedScheduleCancellation","redemption":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedRedemption","retry":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedRetry","scheduled_for_retry":"#/components/schemas/SchemaBillingSubscriptionWebhookExtendedScheduleRetry"}}}},"components/schemas/SchemaBillingSubscriptionWebhookInit":{"id":"components/schemas/SchemaBillingSubscriptionWebhookInit","kind":"json-schema","title":"WebhookSubscriptionInit","data":{"title":"WebhookSubscriptionInit","type":"object","required":["callback_type","subscription","product","customer"],"properties":{"callback_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription event type, representing a specific change in the subscription lifecycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"View parameters specific to a particular callback type by choosing the relevant callback type."},"children":[]}]}]}],"enum":["init"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookRenew":{"id":"components/schemas/SchemaBillingSubscriptionWebhookRenew","kind":"json-schema","title":"WebhookSubscriptionRenew","data":{"title":"WebhookSubscriptionRenew","type":"object","required":["callback_type","subscription","product","customer"],"properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["renew"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success","fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookUpdate":{"id":"components/schemas/SchemaBillingSubscriptionWebhookUpdate","kind":"json-schema","title":"WebhookSubscriptionUpdate","data":{"title":"WebhookSubscriptionUpdate","type":"object","required":["callback_type","subscription","product","customer"],"properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["update"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","updated_at","trial"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active","cancelled","redemption","paused"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."},"cancelled_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of subscription cancellation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This parameter is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", but in other cases, for example in refunds, this parameter is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"cancellation_requested_at":{"type":"string","description":"Datetime of subscription cancellation request.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"]},"cancel_message":{"type":"string","description":"Cancellation reason brief description."},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription pause type value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the datetime is the date and time of the pause start request."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"to_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"}},"required":["from_date"]}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["processing","retry","success","fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookCancel":{"id":"components/schemas/SchemaBillingSubscriptionWebhookCancel","kind":"json-schema","title":"WebhookSubscriptionCancel","data":{"title":"WebhookSubscriptionCancel","type":"object","required":["callback_type","subscription","product","customer"],"properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["cancel"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","cancelled_at","cancellation_requested_at","cancel_code","cancel_message"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["cancelled"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."},"cancelled_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of subscription cancellation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This parameter is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", but in other cases, for example, in refunds, this parameter is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"cancellation_requested_at":{"type":"string","description":"Datetime of subscription cancellation request.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"cancel_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-insights/subscription-cancel-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is used to cancel the subscription."},"children":[]}]}]}],"enum":["8.01","8.02","8.03","8.04","8.05","8.06","8.07","8.08","8.09","8.10","8.11","8.12","8.13","8.14","8.15"]},"cancel_message":{"type":"string","description":"Cancellation reason brief description."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success","fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookPause":{"id":"components/schemas/SchemaBillingSubscriptionWebhookPause","kind":"json-schema","title":"WebhookSubscriptionPause","data":{"title":"WebhookSubscriptionPause","type":"object","required":["callback_type","subscription","product","customer"],"properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["pause"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","pause"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["paused"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription pause type value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the datetime is the date and time of the pause start request."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"to_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"}},"required":["from_date"]}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookResume":{"id":"components/schemas/SchemaBillingSubscriptionWebhookResume","kind":"json-schema","title":"WebhookSubscriptionResume","data":{"title":"WebhookSubscriptionResume","type":"object","required":["callback_type","subscription","product","customer"],"properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["resume"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookCreatePauseSchedule":{"id":"components/schemas/SchemaBillingSubscriptionWebhookCreatePauseSchedule","kind":"json-schema","title":"WebhookSubscriptionCreatePauseSchedule","data":{"title":"WebhookSubscriptionCreatePauseSchedule","type":"object","required":["callback_type","subscription","product","customer"],"properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["pause_schedule.create"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","pause","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription pause type value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the datetime is the date and time of the pause start request."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"to_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"}},"required":["from_date"]}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookUpdatePauseSchedule":{"id":"components/schemas/SchemaBillingSubscriptionWebhookUpdatePauseSchedule","kind":"json-schema","title":"WebhookSubscriptionUpdatePauseSchedule","data":{"title":"WebhookSubscriptionUpdatePauseSchedule","type":"object","required":["callback_type","subscription","product","customer"],"properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["pause_schedule.update"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","pause","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active","paused"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."},"pause":{"type":"object","description":"Pause schedule parameters.","properties":{"from_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause start."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"If the subscription pause type value is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"immediate"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", the datetime is the date and time of the pause start request."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"to_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime of the pause end."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is absent when the subscription is planned to pause infinitely."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"}},"required":["from_date"]}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionWebhookDeletePauseSchedule":{"id":"components/schemas/SchemaBillingSubscriptionWebhookDeletePauseSchedule","kind":"json-schema","title":"WebhookSubscriptionDeletePauseSchedule","data":{"title":"WebhookSubscriptionDeletePauseSchedule","type":"object","required":["callback_type","subscription","product","customer"],"properties":{"callback_type":{"type":"string","description":"Subscription event type, representing a specific change in the subscription lifecycle.","enum":["pause_schedule.delete"]},"subscription":{"type":"object","description":"Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.","required":["id","status","started_at","updated_at","expired_at","payment_type","trial","next_charge_at"],"properties":{"id":{"type":"string","description":"Unique subscription identifier.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active"]},"started_at":{"type":"string","description":"Datetime of the subscription start.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"Datetime of the subscription update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"expired_at":{"type":"string","description":"Datetime of the subscription expiration.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"next_charge_at":{"type":"string","description":"Datetime of the subsequent charge.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"payment_type":{"type":"string","description":"Customer payment method used to pay for a subscription.","enum":["card","paypal-vault","mercadopago","upi","pix","gcash","alipay","mbway","wechatpay"]},"trial":{"type":"boolean","description":"Indicates whether the subscription is in trial period."}}},"product":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookProduct"}]},"customer":{"allOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionWebhookCustomer"}]},"invoices":{"type":"object","description":"Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.","properties":{"<invoice_id_value_#1>":{"type":"object","description":"Invoice for the last billing period.","required":["id","status","created_at","updated_at","amount","orders"],"properties":{"id":{"type":"string","description":"Unique invoice identifier associated with a specific subscription.","maxLength":36,"format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["processing","retry","success","fail"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the invoice creation."},"updated_at":{"type":"string","description":"Datetime of the invoice update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"amount":{"type":"integer","description":"Current subscription price."},"product_price_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique product price identifier applied to the invoice. Use it to distinguish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prices configured for different currencies and locations within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same product for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product and price management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is returned if the product has no prices configured for\n  other currencies and locations."},"children":[]}]}]}],"maxLength":36,"format":"uuid","example":"61b7f690-242a-498c-99a1-eb191f93f08c"},"billing_period_started_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"billing_period_ended_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime of the period covered by the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status."},"children":[]}]}]}]},"subscription_term_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#subscription-process","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled if invoice is created:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"before March 1, 2024 only for the invoice with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"on or after March 1, 2024, regardless of the invoice "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/subscriptions/subscriptions-1.0/subscription-overview/#invoice-statuses","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"status"},"children":[]}]}]}]}]}]},"orders":{"type":"object","description":"Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.","properties":{"<order_id_value_#1>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#1>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order."},"children":[]}]}]}]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"updated_at":{"type":"string","description":"Datetime of the order update.","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"failed_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that indicates the reason for the payment decline. All codes are explained in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/payments-insights/error-codes/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This field appears only for failed orders that are the last or precede a successful one."},"children":[]}]}]}]},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}},"<order_id_value_#2>":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single order, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id_value_#2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a dynamically generated unique order identifier."},"children":[]}]}]}],"required":["id","status","created_at","amount"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique order identifier, which can be used to find the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For the first payment, the identifier is defined by the merchant."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"For recurring subscription-based payments, it is generated by the Solidgate subscription service."},"children":[]}]}]}],"maxLength":255},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the requested order."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Card order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"3ds_verify"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"void_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_ok"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". Card order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"partial_settled"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"APM order"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" statuses are "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"approved"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"declined"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". APM order status "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"settle_pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is not used in subscriptions.\n"},"children":[]}]}],"enum":["created","processing","3ds_verify","auth_ok","auth_failed","void_ok","settle_ok","refunded","approved","declined"]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Datetime of the order creation."},"processed_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime when the order was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is empty for orders in processing."},"children":[]}]}]}]},"amount":{"type":"integer","description":"Original order amount."},"retry_attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of retry attempt for the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filled for orders created according to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/recover-revenue/retry-strategies/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"retry strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]},"payment_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the payer for transactions conducted through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/alternative-payments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APMs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method."},"children":[]}]}]}],"type":"object","properties":{"invoice_id":{"type":"string","description":"Unique invoice identifier provided by PayPal."},"payer_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"It is provided only for the transactions with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"paypal-vault"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" method."},"children":[]}]}]}]}}},"operation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"enum":["pay","recurring","recurring-auth","refund","resign","resign-auth","auth","settle","void","apple-pay","google-pay"],"deprecated":true}}}}},"order_metadata":{"type":"object","description":"Metadata is useful for storing additional, structured information about an object.","additionalProperties":{"type":"string","maxLength":380},"maxProperties":10}}}}}}}},"components/schemas/SchemaBillingSubscriptionDiscriminatorWebhook":{"id":"components/schemas/SchemaBillingSubscriptionDiscriminatorWebhook","kind":"json-schema","title":"Legacy","data":{"title":"Legacy","type":"object","discriminator":{"propertyName":"callback_type","mapping":{"init":"#/components/schemas/SchemaBillingSubscriptionWebhookInit","renew":"#/components/schemas/SchemaBillingSubscriptionWebhookRenew","update":"#/components/schemas/SchemaBillingSubscriptionWebhookUpdate","cancel":"#/components/schemas/SchemaBillingSubscriptionWebhookCancel","pause":"#/components/schemas/SchemaBillingSubscriptionWebhookPause","resume":"#/components/schemas/SchemaBillingSubscriptionWebhookResume","pause_schedule.create":"#/components/schemas/SchemaBillingSubscriptionWebhookCreatePauseSchedule","pause_schedule.update":"#/components/schemas/SchemaBillingSubscriptionWebhookUpdatePauseSchedule","pause_schedule.delete":"#/components/schemas/SchemaBillingSubscriptionWebhookDeletePauseSchedule"}}}},"schema_170":{"kind":"json-schema","data":{"$ref":"#/components/schemas/HeaderMainMerchant"},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"$ref":"#/components/schemas/HeaderMainSignature"},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/RequestCardsCharge"},{"$ref":"#/components/schemas/RequestCardsPaymentChargeDataType"},{"$ref":"#/components/schemas/RequestCardsProductBasedPaymentCharge"},{"$ref":"#/components/schemas/RequestCardsSubscriptionPaymentCharge"}]},"id":"schema_172"},"schema_173":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCardsCharge"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_173"},"schema_174":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/RequestCardsGooglePay"},{"$ref":"#/components/schemas/RequestCardsProductBasedPaymentGooglePay"},{"$ref":"#/components/schemas/RequestCardsSubscriptionPaymentGooglePay"}]},"id":"schema_174"},"schema_175":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCardsGooglePay"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_175"},"schema_176":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/RequestCardsApplePay"},{"$ref":"#/components/schemas/RequestCardsProductBasedPaymentApplePay"},{"$ref":"#/components/schemas/RequestCardsSubscriptionPaymentApplePay"}]},"id":"schema_176"},"schema_177":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCardsApplePay"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_177"},"schema_178":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCardsIncrement"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_178"},"schema_179":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/RequestCardsRecurring"},{"$ref":"#/components/schemas/RequestCardsProductBasedPaymentRecurring"},{"$ref":"#/components/schemas/RequestCardsSubscriptionPaymentRecurring"}]},"id":"schema_179"},"schema_180":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCardsRecurring"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_180"},"schema_181":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/RequestCardsResign"},{"$ref":"#/components/schemas/RequestCardsProductBasedPaymentResign"},{"$ref":"#/components/schemas/RequestCardsSubscriptionPaymentResign"}]},"id":"schema_181"},"schema_182":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCardsResign"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_182"},"schema_183":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCardsRefund"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_183"},"schema_184":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCardsVoid"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_184"},"schema_185":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCardsSettle"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_185"},"schema_186":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCardsStatus"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseCardsError"}]},"id":"schema_186"},"schema_187":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCardsArn"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_187"},"schema_188":{"kind":"json-schema","data":{"$ref":"#/components/schemas/HeaderMainMerchantWebhook"},"id":"schema_188"},"schema_189":{"kind":"json-schema","data":{"type":"string"},"id":"schema_189"},"schema_190":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_190"},"schema_191":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/RequestApmInitPaymentDiscriminator"},{"$ref":"#/components/schemas/RequestApmInitOneTimeProductDiscriminator"},{"$ref":"#/components/schemas/RequestApmInitSubscriptionDiscriminator"}]},"id":"schema_191"},"schema_192":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ResponseApmSuccess"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_192"},"schema_193":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/RequestApmRecurringDiscriminator"},{"$ref":"#/components/schemas/RequestApmRecurringOneTimeProductDiscriminator"},{"$ref":"#/components/schemas/RequestApmRecurringSubscriptionDiscriminator"}]},"id":"schema_193"},"schema_194":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseApmRecurring"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_194"},"schema_195":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseApmRecurringTokenCancellation"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseApmRecurringTokenCancellationError"}]},"id":"schema_195"},"schema_196":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseApmRefund"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_196"},"schema_197":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseApmCheckOrderStatus"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseApmError"}]},"id":"schema_197"},"schema_198":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/RequestBillingProductCreateOneTime"},{"$ref":"#/components/schemas/RequestBillingProductCreateSubscription"}]},"id":"schema_198"},"schema_199":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ResponseBillingProductCreateOneTime"},{"$ref":"#/components/schemas/ResponseBillingProductCreateSubscription"}]},"id":"schema_199"},"schema_200":{"kind":"json-schema","data":{"type":"string","example":"ac43b415-5522-4373-b026-a365462f9657,xx33b415-5522-4373-b026-a365462f9657","maxLength":100},"id":"schema_200"},"schema_201":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the status of products to retrieve. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return products that match the needed status."},"children":[]}]}]}],"enum":["active","disabled","archived"]},"id":"schema_201"},"schema_202":{"kind":"json-schema","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify whether the products should have a trial available. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve products with a trial option."},"children":[]}]}]}]},"id":"schema_202"},"schema_203":{"kind":"json-schema","data":{"description":"Specify the number of items to return.","type":"integer","example":10,"default":10,"minimum":1,"maximum":100},"id":"schema_203"},"schema_204":{"kind":"json-schema","data":{"description":"Specify the number of items to skip before starting to collect the result set.","type":"integer","example":10,"default":0,"minimum":0},"id":"schema_204"},"schema_205":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ResponseBillingProductCreateListOneTime"},{"$ref":"#/components/schemas/ResponseBillingProductCreateListSubscription"}]},"id":"schema_205"},"schema_206":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"example":"ac43b415-5522-4373-b026-a365462f9657","format":"uuid","maxLength":36,"minLength":36},"id":"schema_206"},"schema_207":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/RequestBillingProductUpdateOneTime"},{"$ref":"#/components/schemas/RequestBillingProductUpdateSubscription"}]},"id":"schema_207"},"schema_208":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ResponseBillingProductUpdateOneTime"},{"$ref":"#/components/schemas/ResponseBillingProductUpdateSubscription"}]},"id":"schema_208"},"schema_209":{"kind":"json-schema","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.solidgate.com/billing/manage-products/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier."},"children":[]}]}]}],"example":"ac43b415-5522-4373-b026-a365462f9657","format":"uuid","maxLength":36,"minLength":36},"id":"schema_209"},"schema_210":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ResponseBillingProductGetByIdOneTime"},{"$ref":"#/components/schemas/ResponseBillingProductGetByIdSubscription"}]},"id":"schema_210"},"schema_211":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ResponseBillingProductArchiveOneTime"},{"$ref":"#/components/schemas/ResponseBillingProductArchiveSubscription"}]},"id":"schema_211"},"schema_212":{"kind":"json-schema","data":{"type":"string","example":"EUR, USD"},"id":"schema_212"},"schema_213":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the country "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"iso_code_a3","example":"USA","maxLength":3,"minLength":3},"id":"schema_213"},"schema_214":{"kind":"json-schema","data":{"description":"Unique product price identifier.","type":"string","format":"uuid","example":"fa43b415-5522-4373-b026-a365562f9649"},"id":"schema_214"},"schema_215":{"kind":"json-schema","data":{"properties":{"date_from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime for the report stated in UTC+0."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-01-15 11:00:00"},"date_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime for the report stated in UTC+0."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-06-20 13:00:00"},"environment":{"type":"string","enum":["live","sandbox","all"],"default":"all","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment for the transactional tax report."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"live"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – live environment, containing live data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sandbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – testing environment with non-live data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – includes data from both live and sandbox environments"},"children":[]}]}]}]}],"example":"all"}},"required":["date_from","date_to"]},"id":"schema_215"},"schema_216":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseBillingReportTaxTransactional"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_216"},"schema_217":{"kind":"json-schema","data":{"type":"string","example":"TAX_250702_140728_CHECKOUT"},"id":"schema_217"},"schema_218":{"kind":"json-schema","data":{"properties":{"date_from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime for the report stated in UTC+0."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-01-15 11:00:00"},"date_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime for the report stated in UTC+0."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-06-20 13:00:00"},"environment":{"type":"string","enum":["live","sandbox","all"],"default":"all","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment for the summary tax report."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"live"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – live environment, containing live data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sandbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – testing environment with non-live data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – includes data from both live and sandbox environments"},"children":[]}]}]}]}],"example":"all"}},"required":["date_from","date_to"]},"id":"schema_218"},"schema_219":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseBillingReportTaxSummary"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_219"},"schema_220":{"kind":"json-schema","data":{"anyOf":[{"title":"Success","type":"object","properties":{"status":{"type":"string","description":"Product has been switched.","example":"ok"}}},{"$ref":"#/components/schemas/ResponseBillingValidationError"}]},"id":"schema_220"},"schema_221":{"kind":"json-schema","data":{"type":"string","format":"uuid","maxLength":36,"minLength":36},"id":"schema_221"},"schema_222":{"kind":"json-schema","data":{"anyOf":[{"title":"Success","type":"object","properties":{"status":{"type":"string","description":"Subscription has been cancelled.","example":"ok"}}},{"$ref":"#/components/schemas/ResponseBillingValidationError"}]},"id":"schema_222"},"schema_223":{"kind":"json-schema","data":{"anyOf":[{"title":"Success","type":"object","properties":{"status":{"type":"string","description":"Subscription has been cancelled for the customer.","example":"ok"}}},{"$ref":"#/components/schemas/ResponseBillingValidationError"}]},"id":"schema_223"},"schema_224":{"kind":"json-schema","data":{"anyOf":[{"title":"Success","type":"object","properties":{"status":{"type":"string","description":"Subscription has been restored.","example":"ok"}}},{"$ref":"#/components/schemas/ResponseBillingValidationError"}]},"id":"schema_224"},"schema_225":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/SchemaBillingSubscriptionDiscriminatorWebhookExtended"},{"$ref":"#/components/schemas/SchemaBillingSubscriptionDiscriminatorWebhook"}]},"id":"schema_225"},"schema_226":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseBillingSubscriptionStatus"},{"$ref":"#/components/schemas/ResponseBillingValidationError"}]},"id":"schema_226"},"schema_227":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseBillingSubscriptionRetrieveCustomer"},{"$ref":"#/components/schemas/ResponseBillingValidationError"}]},"id":"schema_227"},"schema_228":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseRisksFraudPreventionListItemsCreate"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_228"},"schema_229":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseRisksFraudPreventionListItemList"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_229"},"schema_230":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseRisksFraudPreventionListItem"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseMainError"}]},"id":"schema_230"},"schema_231":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseRisksDisputeRepresentmentsCreate"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_231"},"schema_232":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseRisksDisputeRepresentmentsEnrich"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_232"},"schema_233":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/RequestCheckoutSolutionsCreatePage"},{"$ref":"#/components/schemas/RequestCheckoutSolutionsCreateSubscriptionPaymentPage"},{"$ref":"#/components/schemas/RequestCheckoutSolutionsCreateInvoicePaymentPage"}]},"id":"schema_233"},"schema_234":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCheckoutSolutionsPage"},{"$ref":"#/components/schemas/ResponseCheckoutSolutionsAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseCheckoutSolutionsError"}]},"id":"schema_234"},"schema_235":{"kind":"json-schema","data":{"anyOf":[{"title":"Success","type":"object","properties":{"status":{"type":"string","description":"Payment page has been deactivated.","example":"ok"}}},{"$ref":"#/components/schemas/ResponseCheckoutSolutionsAuthenticationFailed"}]},"id":"schema_235"},"schema_236":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCheckoutSolutionsError"}]},"id":"schema_236"},"schema_237":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/RequestCheckoutSolutionsCreateLink"},{"$ref":"#/components/schemas/RequestCheckoutSolutionsCreateSubscriptionPaymentLink"},{"$ref":"#/components/schemas/RequestCheckoutSolutionsCreateInvoicePaymentLink"}]},"id":"schema_237"},"schema_238":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseCheckoutSolutionsLink"},{"$ref":"#/components/schemas/ResponseCheckoutSolutionsAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseCheckoutSolutionsError"}]},"id":"schema_238"},"schema_239":{"kind":"json-schema","data":{"anyOf":[{"title":"Success","type":"object","properties":{"status":{"type":"string","description":"Payment link has been deactivated.","example":"ok"}}},{"$ref":"#/components/schemas/ResponseCheckoutSolutionsAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseCheckoutSolutionsError"}]},"id":"schema_239"},"schema_240":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseWebhooks"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_240"},"schema_241":{"kind":"json-schema","data":{"type":"string","maxLength":50,"example":"ac43b415-5522-4373-b026-a365462f9657"},"id":"schema_241"},"schema_242":{"kind":"json-schema","data":{"type":"integer","description":"Number of items to return.","default":10,"minimum":1,"maximum":100,"example":10},"id":"schema_242"},"schema_243":{"kind":"json-schema","data":{"type":"integer","description":"Number of items to skip before collecting the result set.","default":0,"minimum":0,"example":10},"id":"schema_243"},"schema_244":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseWebhookEndpointList"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_244"},"schema_245":{"kind":"json-schema","data":{"type":"object","allOf":[{"type":"object","properties":{"filter":{"default":"updated_at"}}},{"$ref":"#/components/schemas/RequestReportsGeneral"}]},"id":"schema_245"},"schema_246":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseReportsCardOrders"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_246"},"schema_247":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseReportsApmOrders"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_247"},"schema_248":{"kind":"json-schema","data":{"allOf":[{"type":"object","properties":{"filter":{"default":"updated_at"}}},{"$ref":"#/components/schemas/RequestReportsGeneral"}]},"id":"schema_248"},"schema_249":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseReportsSubscriptions"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_249"},"schema_250":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseReportsChargebacks"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_250"},"schema_251":{"kind":"json-schema","data":{"type":"object","allOf":[{"type":"object","properties":{"filter":{"default":"created_at"}}},{"$ref":"#/components/schemas/RequestReportsGeneral"}]},"id":"schema_251"},"schema_252":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseReportsPaypalDisputes"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_252"},"schema_253":{"kind":"json-schema","data":{"type":"object","required":["date_from","date_to"],"properties":{"filter":{"type":"string","description":"Filtering criteria for the report data.","default":"created_at","enum":["updated_at","created_at"],"example":"created_at"},"date_from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime for the report stated in UTC+0."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-08-15 11:00:00"},"date_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime for the report stated in UTC+0."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-09-20 13:00:00"}}},"id":"schema_253"},"schema_254":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseReportsPreventionAlerts"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_254"},"schema_255":{"kind":"json-schema","data":{"type":"string","example":"PREVENT_250702_140728_CHECKOUT"},"id":"schema_255"},"schema_256":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseReportsFraudAlerts"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_256"},"schema_257":{"kind":"json-schema","data":{"properties":{"date_from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start datetime for the report stated in UTC+0."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-08-15 11:00:00"},"date_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End datetime for the report stated in UTC+0."},"children":[]}]}]}],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2025-09-20 13:00:00"},"filter":{"type":"string","enum":["created_at","accounting_date","transaction_datetime_utc","transaction_datetime_provider"],"default":"created_at","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date field to filter the report by."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - date and time when the record was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accounting_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – determines the settlement or invoice inclusion date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_datetime_utc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – transaction or fee date in UTC"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_datetime_provider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – transaction or fee date in provider's local timezone"},"children":[]}]}]}]}],"example":"created_at"}},"required":["date_from","date_to"]},"id":"schema_257"},"schema_258":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseReportsFinancialEntries"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_258"},"schema_259":{"kind":"json-schema","data":{"type":"string","example":"FIN_250702_140728_CHECKOUT"},"id":"schema_259"},"schema_260":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseReportsRoutingV2Report"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"}]},"id":"schema_260"},"schema_261":{"kind":"json-schema","data":{"type":"string","example":"ROUTING_250702_140728_CHECKOUT"},"id":"schema_261"},"schema_262":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResponseFilesCreateFileUpload"},{"$ref":"#/components/schemas/ResponseMainAuthenticationFailed"},{"$ref":"#/components/schemas/ResponseFilesError"}]},"id":"schema_262"}},"exampleStore":{"components/examples/ExampleCheckoutSolutionsCreatePage":{"id":"components/examples/ExampleCheckoutSolutionsCreatePage","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","force3ds":false,"google_pay_allowed_auth_methods":["PAN_ONLY"],"customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+11234567890","billing_address":{"country":"USA","state":"NY","city":"New York","zip":"10001","address":"123 Main St"},"dynamic_descriptor":{"suffix":"PRODUCTX"},"payment_type_data":{"klarna_network_session_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.klarna_session_token_example","klarna_network_data":"{\"order_lines\":[{\"name\":\"Premium package\",\"quantity\":1,\"unit_price\":1020,\"total_amount\":1020}]}","sweden_pin":"19811228-9874"},"traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","language":"pt","website":"https://merchant.example","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"page_customization":{"public_name":"Public Name","order_title":"Order Title","order_description":"Premium package","payment_methods":["paypal","klarna-network"],"button_font_color":"#FFFFFF","button_color":"#00816A","font_name":"Open Sans","is_cardholder_visible":true,"terms_url":"https://merchant.example/terms","back_url":"https://merchant.example/back"}}},"components/examples/ExampleCheckoutSolutionsCreateSubscriptionPaymentPage":{"id":"components/examples/ExampleCheckoutSolutionsCreateSubscriptionPaymentPage","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"fa43b415-5522-4373-b026-a365562f9649","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_number":9,"settle_interval":0,"authorization_type":"final","retry_attempt":3,"force3ds":false,"google_pay_allowed_auth_methods":["PAN_ONLY"],"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+11234567890","billing_address":{"country":"USA","state":"NY","city":"New York","zip":"10001","address":"123 Main St"},"dynamic_descriptor":{"suffix":"PRODUCTX"},"traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","language":"pt","website":"https://merchant.example","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"page_customization":{"public_name":"Public Name","order_title":"Order Title","order_description":"Premium package","payment_methods":["paypal"],"button_font_color":"#FFFFFF","button_color":"#00816A","font_name":"Open Sans","is_cardholder_visible":true,"terms_url":"https://merchant.example/terms","back_url":"https://merchant.example/back"}}},"components/examples/ExampleCheckoutSolutionsCreateInvoicePaymentPage":{"id":"components/examples/ExampleCheckoutSolutionsCreateInvoicePaymentPage","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","force3ds":false,"google_pay_allowed_auth_methods":["PAN_ONLY"],"customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+11234567890","billing_address":{"country":"USA","state":"NY","city":"New York","zip":"10001","address":"123 Main St"},"dynamic_descriptor":{"suffix":"PRODUCTX"},"traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","language":"pt","website":"https://merchant.example","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"page_customization":{"public_name":"Public Name","order_title":"Order Title","order_description":"Premium package","payment_methods":["paypal"],"button_font_color":"#FFFFFF","button_color":"#00816A","font_name":"Open Sans","is_cardholder_visible":true,"terms_url":"https://merchant.example/terms","back_url":"https://merchant.example/back"}}},"components/examples/ExampleCheckoutSolutionsResponseCreatePage":{"id":"components/examples/ExampleCheckoutSolutionsResponseCreatePage","value":{"url":"https://payment-page.merchant.example/VxKnj3D","id":"VxKnj3D"}},"components/examples/ExampleCheckoutSolutionsResponseAuthenticationFailed":{"id":"components/examples/ExampleCheckoutSolutionsResponseAuthenticationFailed","value":{"error":{"code":"1.01","message":{"auth":"Authentication failed"}}}},"components/examples/ExampleCheckoutSolutionsResponseValidationError":{"id":"components/examples/ExampleCheckoutSolutionsResponseValidationError","value":{"error":{"code":"2.01","message":{"id":"must be a string"}}}},"components/examples/ExampleCheckoutSolutionsResponseSuccessDeactivate":{"id":"components/examples/ExampleCheckoutSolutionsResponseSuccessDeactivate","value":{"status":"ok"}},"components/examples/ExampleCheckoutDeactivateLinkError":{"id":"components/examples/ExampleCheckoutDeactivateLinkError","value":{"error":{"code":"2.01","message":{"id":"must be a string"}}}},"components/examples/ExampleCheckoutSolutionsCreateLink":{"id":"components/examples/ExampleCheckoutSolutionsCreateLink","value":{"order":{"amount":1020,"currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","settle_interval":0,"authorization_type":"final","google_pay_allowed_auth_methods":["PAN_ONLY"],"dynamic_descriptor":{"suffix":"PRODUCTX"},"payment_type_data":{"klarna_network_session_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.klarna_session_token_example","klarna_network_data":"{\"order_lines\":[{\"name\":\"Premium package\",\"quantity\":1,\"unit_price\":1020,\"total_amount\":1020}]}","sweden_pin":"19811228-9874"},"traffic_source":"facebook","transaction_source":"main_menu","language":"pt","website":"https://merchant.example","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success"},"page_customization":{"public_name":"Public Name","order_title":"Order Title","order_description":"Premium package","payment_methods":["paypal","klarna-network"],"button_font_color":"#FFFFFF","button_color":"#00816A","font_name":"Open Sans","is_cardholder_visible":true,"terms_url":"https://merchant.example/terms","back_url":"https://merchant.example/back"},"configuration":{"usage_mode":"reusable","amount_setter":"merchant"}}},"components/examples/ExampleCheckoutSolutionsCreateSubscriptionPaymentLink":{"id":"components/examples/ExampleCheckoutSolutionsCreateSubscriptionPaymentLink","value":{"order":{"product_id":"fa43b415-5522-4373-b026-a365562f9649","order_description":"Premium package","settle_interval":0,"authorization_type":"final","google_pay_allowed_auth_methods":["PAN_ONLY"],"dynamic_descriptor":{"suffix":"PRODUCTX"},"traffic_source":"facebook","transaction_source":"main_menu","language":"pt","website":"https://merchant.example","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success"},"page_customization":{"public_name":"Public Name","order_title":"Order Title","order_description":"Premium package","payment_methods":["paypal"],"button_font_color":"#FFFFFF","button_color":"#00816A","font_name":"Open Sans","is_cardholder_visible":true,"terms_url":"https://merchant.example/terms","back_url":"https://merchant.example/back"}}},"components/examples/ExampleCheckoutSolutionsCreateInvoicePaymentLink":{"id":"components/examples/ExampleCheckoutSolutionsCreateInvoicePaymentLink","value":{"order":{"invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","settle_interval":0,"authorization_type":"final","google_pay_allowed_auth_methods":["PAN_ONLY"],"dynamic_descriptor":{"suffix":"PRODUCTX"},"traffic_source":"facebook","transaction_source":"main_menu","language":"pt","website":"https://merchant.example","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success"},"page_customization":{"public_name":"Public Name","order_title":"Order Title","order_description":"Premium package","payment_methods":["paypal"],"button_font_color":"#FFFFFF","button_color":"#00816A","font_name":"Open Sans","is_cardholder_visible":true,"terms_url":"https://merchant.example/terms","back_url":"https://merchant.example/back"},"configuration":{"usage_mode":"reusable","amount_setter":"merchant"}}},"components/examples/ExampleCheckoutSolutionsResponseCreateLink":{"id":"components/examples/ExampleCheckoutSolutionsResponseCreateLink","value":{"url":"https://payment-page.merchant.example/link/Q6J3212g7K","id":"Q6J3212g7K"}},"components/examples/ExampleCardsRequestChargePaymentPan":{"id":"components/examples/ExampleCardsRequestChargePaymentPan","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"card_data_type":"pan","settle_interval":0,"authorization_type":"final","payment_type":"1-click","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"05","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12120001111","card_number":"4067429974719265","card_holder":"John Snow","card_exp_month":"12","card_exp_year":2025,"card_cvv":"123","card_pin":"4492","dynamic_descriptor":{"suffix":"PRODUCTX"},"industry_data":{"type":"airline","airline":[{"airline_code":"001","airline_designator_code":"DL","airline_name":"Delta Airlines","boarding_fee":"500","computerized_reservation_system":"AMAD","customer_reference_number":"A123456789","document_type":"01","flight_date":"2025-09-01 14:30","agency_plan_name":"1B","travel_agency_name":"Skyline Travel","travel_agency_code":"87654321","agency_invoice_number":"INV123","ticket":{"number":"5661234567890","issue_date":"250819","restricted":false,"issue_address":{"line1":"123 Main St","city":"Atlanta","country":"USA","postal":"30301"}},"passenger":{"first_name":"John","last_name":"Doe","date_of_birth":"1985-03-21","phone_number":"+14051234567","traveller_type":"ADT","code":"123"},"flight_legs":[{"flight_number":"DL101","carrier_code":"DL","class_of_travel":"Y","departure_date":"2025-09-01 14:30","departure_airport":"ATL","departure_tax":"100","arrival_airport":"LAX","fare_base_code":"Y123","stop_over_code":"X"}]},{"airline_code":"002","airline_designator_code":"AA","airline_name":"American Airlines","boarding_fee":"500","computerized_reservation_system":"AMAD","customer_reference_number":"B987654321","document_type":"01","flight_date":"2025-10-01 16:00","agency_plan_name":"2A","travel_agency_name":"Global Travel Co","travel_agency_code":"98765432","agency_invoice_number":"INV987","ticket":{"number":"5670987654321","issue_date":"250925","restricted":true,"issue_address":{"line1":"456 Elm St","city":"Dallas","country":"USA","postal":"75201"}},"passenger":{"first_name":"Jane","last_name":"Smith","date_of_birth":"1990-11-10","phone_number":"+14051234568","traveller_type":"ADT","code":"124"},"flight_legs":[{"flight_number":"AA102","carrier_code":"AA","class_of_travel":"Y","departure_date":"2025-10-01 16:00","departure_airport":"DFW","departure_tax":"150","arrival_airport":"ORD","fare_base_code":"Y456","stop_over_code":"X"}]}]},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsRequestChargePaymentDpan":{"id":"components/examples/ExampleCardsRequestChargePaymentDpan","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"card_data_type":"dpan","dpan_source":"apple-pay","eci":"05","cryptogram":"YwAAABkAg0+NbusAMjqEAoABFA=","settle_interval":0,"authorization_type":"final","payment_type":"1-click","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"01","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12120001111","card_number":"4067429974719265","card_holder":"John Snow","card_exp_month":"12","card_exp_year":2025,"card_cvv":"123","card_pin":"4492","dynamic_descriptor":{"suffix":"PRODUCTX"},"industry_data":{"type":"airline","airline":[{"airline_code":"001","airline_designator_code":"DL","airline_name":"Delta Airlines","boarding_fee":"500","computerized_reservation_system":"AMAD","customer_reference_number":"A123456789","document_type":"01","flight_date":"2025-09-01 14:30","agency_plan_name":"1B","travel_agency_name":"Skyline Travel","travel_agency_code":"87654321","agency_invoice_number":"INV123","ticket":{"number":"5661234567890","issue_date":"250819","restricted":false,"issue_address":{"line1":"123 Main St","city":"Atlanta","country":"USA","postal":"30301"}},"passenger":{"first_name":"John","last_name":"Doe","date_of_birth":"1985-03-21","phone_number":"+14051234567","traveller_type":"ADT","code":"123"},"flight_legs":[{"flight_number":"DL101","carrier_code":"DL","class_of_travel":"Y","departure_date":"2025-09-01 14:30","departure_airport":"ATL","departure_tax":"100","arrival_airport":"LAX","fare_base_code":"Y123","stop_over_code":"X"}]},{"airline_code":"002","airline_designator_code":"AA","airline_name":"American Airlines","boarding_fee":"500","computerized_reservation_system":"AMAD","customer_reference_number":"B987654321","document_type":"01","flight_date":"2025-10-01 16:00","agency_plan_name":"2A","travel_agency_name":"Global Travel Co","travel_agency_code":"98765432","agency_invoice_number":"INV987","ticket":{"number":"5670987654321","issue_date":"250925","restricted":true,"issue_address":{"line1":"456 Elm St","city":"Dallas","country":"USA","postal":"75201"}},"passenger":{"first_name":"Jane","last_name":"Smith","date_of_birth":"1990-11-10","phone_number":"+14051234568","traveller_type":"ADT","code":"124"},"flight_legs":[{"flight_number":"AA102","carrier_code":"AA","class_of_travel":"Y","departure_date":"2025-10-01 16:00","departure_airport":"DFW","departure_tax":"150","arrival_airport":"ORD","fare_base_code":"Y456","stop_over_code":"X"}]}]},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsRequestProductBasedPaymentCharge":{"id":"components/examples/ExampleCardsRequestProductBasedPaymentCharge","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"83b19018-cbc4-45f0-899a-dda84fd2705e","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","payment_type":"1-click","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"07","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_number":"4067429974719265","card_holder":"John Snow","card_exp_month":"12","card_exp_year":2025,"card_cvv":"123","card_pin":"4492","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsRequestSubscriptionPaymentCharge":{"id":"components/examples/ExampleCardsRequestSubscriptionPaymentCharge","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"83b19018-cbc4-45f0-899a-dda84fd2705e","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","payment_type":"1-click","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","retry_attempt":3,"force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"07","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_number":"4067429974719265","card_holder":"John Snow","card_exp_month":"12","card_exp_year":2025,"card_cvv":"123","card_pin":"4492","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsResponseCharge":{"id":"components/examples/ExampleCardsResponseCharge","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"settle_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"06","flow":"challenge","exception":"transaction_risk_assessment"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"verify_url":"https://merchant.example/verify","redirect_url":"https://merchant.example/redirect","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleMainResponseErrorAuthFailed":{"id":"components/examples/ExampleMainResponseErrorAuthFailed","value":{"error":{"code":"1.01","messages":["Authentication failed"]}}},"components/examples/ExampleMainResponseErrorInvalidData":{"id":"components/examples/ExampleMainResponseErrorInvalidData","value":{"error":{"code":"2.01","messages":["Invalid data"]}}},"components/examples/ExampleMainResponseErrorOrderNotFound":{"id":"components/examples/ExampleMainResponseErrorOrderNotFound","value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}}},"components/examples/ExampleMainResponseError":{"id":"components/examples/ExampleMainResponseError","value":{"error":{"code":"3.02","messages":["Insufficient funds"],"recommended_message_for_user":"The card balance has insufficient funds."}}},"components/examples/ExampleCardsRequestGooglePay":{"id":"components/examples/ExampleCardsRequestGooglePay","value":{"is_decrypted":false,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","force3ds":false,"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_holder":"John Snow","dynamic_descriptor":{"suffix":"PRODUCTX"},"industry_data":{"type":"car_rental","car_rental":{"agreement_number":"BKID12345","renter_name":"John","pick_up_date":"2026-03-01T11:00:00Z","drop_off_date":"2026-03-05T16:30:00Z","refundability":"partially_refundable","rate":1000,"rate_indicator":"D","days_rented":"10","customer_service_toll_free_number":"8001010123","rental_class_id":"0001","tax_exempt_indicator":"Y","fuel_charges":2000,"insurance_charges":2300,"no_show_indicator":"N","one_way_drop_off_charges":50000,"return_location_id":"AB1234","pick_up_location":{"street_line_1":"1 Example Street","state":"CA","city":"San Francisco","country":"USA","postal":"SW1A1AA"},"drop_off_location":{"street_line_1":"1 Example Street","state":"CA","city":"San Francisco","country":"USA","postal":"SW1A1AA"},"distance_limit":{"limit":500,"unit":"miles","additional_distance_cost":{"amount":150,"currency":"USD"}}}},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","signature":"MEQCIGJGG....0ZpM4YzvUA==","signedMessage":"{\"encryptedMessage\":\"J......t1+Eu003d\"}","protocolVersion":"ECv1","network":"VISA","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsRequestProductBasedPaymentGooglePay":{"id":"components/examples/ExampleCardsRequestProductBasedPaymentGooglePay","value":{"is_decrypted":false,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"83b19018-cbc4-45f0-899a-dda84fd2705e","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","force3ds":false,"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_holder":"John Snow","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","signature":"MEQCIGJGG....0ZpM4YzvUA==","signedMessage":"{\"\"\"\"encryptedMessage\"\"\"\":\"\"J......t1+Eu003d\"\"}","protocolVersion":"ECv1","network":"VISA","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsRequestSubscriptionPaymentGooglePay":{"id":"components/examples/ExampleCardsRequestSubscriptionPaymentGooglePay","value":{"is_decrypted":false,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"83b19018-cbc4-45f0-899a-dda84fd2705e","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","retry_attempt":3,"force3ds":false,"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_holder":"John Snow","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","signature":"MEQCIGJGG....0ZpM4YzvUA==","signedMessage":"{\"\"\"\"encryptedMessage\"\"\"\":\"\"J......t1+Eu003d\"\"}","protocolVersion":"ECv1","network":"VISA","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsResponseGooglePay":{"id":"components/examples/ExampleCardsResponseGooglePay","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"processing","auth_code":"2w9m8","payment_type":"1-click","payment_method":"google-pay","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"05","flow":"frictionless","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"verify_url":"https://merchant.example/verify","redirect_url":"https://merchant.example/redirect","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleCardsRequestApplePay":{"id":"components/examples/ExampleCardsRequestApplePay","value":{"is_decrypted":false,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12120001111","dynamic_descriptor":{"suffix":"PRODUCTX"},"industry_data":{"type":"car_rental","car_rental":{"agreement_number":"BKID12345","renter_name":"John","pick_up_date":"2026-03-01T11:00:00Z","drop_off_date":"2026-03-05T16:30:00Z","refundability":"partially_refundable","rate":1000,"rate_indicator":"D","days_rented":"10","customer_service_toll_free_number":"8001010123","rental_class_id":"0001","tax_exempt_indicator":"Y","fuel_charges":2000,"insurance_charges":2300,"no_show_indicator":"N","one_way_drop_off_charges":50000,"return_location_id":"AB1234","pick_up_location":{"street_line_1":"1 Example Street","state":"CA","city":"San Francisco","country":"USA","postal":"SW1A1AA"},"drop_off_location":{"street_line_1":"1 Example Street","state":"CA","city":"San Francisco","country":"USA","postal":"SW1A1AA"},"distance_limit":{"limit":500,"unit":"miles","additional_distance_cost":{"amount":150,"currency":"USD"}}}},"ip_address":"203.0.113.0","traffic_source":"facebook","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","zip_code":"90210","country":"USA","state":"WA","city":"Baltimore","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","address":"123 Main St","zip":"91191"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","data":"qIEHeSmLKw8C5...ZIuf2oPeLhQ1DCaQj","signature":"1UdDwEB/wQEAwIHgDAPBgkqh...92ICIAR2","version":"EC_v1","network":"VISA","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"header":{"transactionId":"7126df4ff8ac61dc60278b5cd549cc98d16b8f41","applicationData":null,"ephemeralPublicKey":"MFkwEwY......+Dh2JDCwaKeLKXQ0cUM9ya/1wnrtMHXN4A==","publicKeyHash":"mQaQhyhrXX3ZDSQv...ByX0iii0MVHthSQiXQ=","wrappedKey":null},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsRequestProductBasedPaymentApplePay":{"id":"components/examples/ExampleCardsRequestProductBasedPaymentApplePay","value":{"is_decrypted":false,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","ip_address":"203.0.113.0","traffic_source":"facebook","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","data":"qIEHeSmLKw3C5...ZIuf2oPeLhQ1DCaQj","signature":"1UdDwEB/wQEAwIHgDAPBgkqh...92ICIAR2","version":"EC_v1","network":"VISA","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"dynamic_descriptor":{"suffix":"PRODUCTX"},"header":{"transactionId":"7126df4ff8ac61dc60278b5cd549cc98d16b8f41","applicationData":null,"ephemeralPublicKey":"MFkwEwY......+Dh2JDCwaKeLKXQ0cUM9ya/1wnrtMHXN4A==","publicKeyHash":"mQaQhyhrXX3ZDSQv...ByX0iii0MVHthSQiXQ=","wrappedKey":null},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsRequestSubscriptionPaymentApplePay":{"id":"components/examples/ExampleCardsRequestSubscriptionPaymentApplePay","value":{"is_decrypted":false,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","retry_attempt":3,"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","ip_address":"203.0.113.0","traffic_source":"facebook","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","data":"qIEHeSmLKw3C5...ZIuf2oPeLhQ1DCaQj","signature":"1UdDwEB/wQEAwIHgDAPBgkqh...92ICIAR2","version":"EC_v1","network":"VISA","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"dynamic_descriptor":{"suffix":"PRODUCTX"},"header":{"transactionId":"7126df4ff8ac61dc60278b5cd549cc98d16b8f41","applicationData":null,"ephemeralPublicKey":"MFkwEwY......+Dh2JDCwaKeLKXQ0cUM9ya/1wnrtMHXN4A==","publicKeyHash":"mQaQhyhrXX3ZDSQv...ByX0iii0MVHthSQiXQ=","wrappedKey":null},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsResponseApplePay":{"id":"components/examples/ExampleCardsResponseApplePay","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"settle_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"apple-pay","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"05","flow":"frictionless","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleCardsRequestIncrement":{"id":"components/examples/ExampleCardsRequestIncrement","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":500}},"components/examples/ExampleCardsResponseIncrement":{"id":"components/examples/ExampleCardsResponseIncrement","value":{"transaction":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","amount":500,"currency":"EUR","status":"processing"}}},"components/examples/ExampleMainResponseErrorCardBrandNotSupported":{"id":"components/examples/ExampleMainResponseErrorCardBrandNotSupported","value":{"error":{"code":"2.04","messages":["Card brand is not supported"]}}},"components/examples/ExampleCardsRequestRecurring":{"id":"components/examples/ExampleCardsRequestRecurring","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","payment_type":"1-click","recurring_token":"7ats8da7sd8-a66dfa7-a9s9das89t","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"01","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsRequestProductBasedPaymentRecurring":{"id":"components/examples/ExampleCardsRequestProductBasedPaymentRecurring","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","payment_type":"1-click","recurring_token":"7ats8da7sd8-a66dfa7-a9s9das89t","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"01","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsRequestSubscriptionPaymentRecurring":{"id":"components/examples/ExampleCardsRequestSubscriptionPaymentRecurring","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"83b19018-cbc4-45f0-899a-dda84fd2705e","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","payment_type":"1-click","recurring_token":"7ats8da7sd8-a66dfa7-a9s9das89t","retry_attempt":3,"force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"06","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsResponseRecurring":{"id":"components/examples/ExampleCardsResponseRecurring","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"settle_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"recurring-auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"recurring-auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"01","flow":"frictionless","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleCardsRequestResign":{"id":"components/examples/ExampleCardsRequestResign","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","recurring_token":"7ats8da7sd8-a66dfa7-a9s9das89t","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"05","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_cvv":"123","dynamic_descriptor":{"suffix":"PRODUCTX"},"industry_data":{"type":"car_rental","car_rental":{"agreement_number":"BKID12345","renter_name":"John","pick_up_date":"2026-03-01T11:00:00Z","drop_off_date":"2026-03-05T16:30:00Z","refundability":"partially_refundable","rate":1000,"rate_indicator":"D","days_rented":"10","customer_service_toll_free_number":"8001010123","rental_class_id":"0001","tax_exempt_indicator":"Y","fuel_charges":2000,"insurance_charges":2300,"no_show_indicator":"N","one_way_drop_off_charges":50000,"return_location_id":"AB1234","pick_up_location":{"street_line_1":"1 Example Street","state":"CA","city":"San Francisco","country":"USA","postal":"SW1A1AA"},"drop_off_location":{"street_line_1":"1 Example Street","state":"CA","city":"San Francisco","country":"USA","postal":"SW1A1AA"},"distance_limit":{"limit":500,"unit":"miles","additional_distance_cost":{"amount":150,"currency":"USD"}}}},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","zip_code":"90210","country":"USA","state":"WA","city":"Baltimore","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsRequestProductBasedPaymentResign":{"id":"components/examples/ExampleCardsRequestProductBasedPaymentResign","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","recurring_token":"7ats8da7sd8-a66dfa7-a9s9das89t","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"05","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_cvv":"123","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsRequestSubscriptionPaymentResign":{"id":"components/examples/ExampleCardsRequestSubscriptionPaymentResign","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"83b19018-cbc4-45f0-899a-dda84fd2705e","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","recurring_token":"7ats8da7sd8-a66dfa7-a9s9das89t","retry_attempt":3,"force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"02","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_cvv":"123","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleCardsResponseResign":{"id":"components/examples/ExampleCardsResponseResign","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"settle_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"02","flow":"none","exception":"transaction_risk_assessment"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"verify_url":"https://merchant.example/verify","redirect_url":"https://merchant.example/redirect","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleCardsRequestRefund":{"id":"components/examples/ExampleCardsRequestRefund","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"refund_reason_code":"0022"}},"components/examples/ExampleCardsResponseRefund":{"id":"components/examples/ExampleCardsResponseRefund","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"processing","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"07","flow":"unspecified","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleCardsResponseVoid":{"id":"components/examples/ExampleCardsResponseVoid","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"settle_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"05","flow":"frictionless","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleCardsResponseSettle":{"id":"components/examples/ExampleCardsResponseSettle","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"settle_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"06","flow":"challenge","exception":"transaction_risk_assessment"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleCardsResponseStatus":{"id":"components/examples/ExampleCardsResponseStatus","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"authorized_amount":100,"status":"auth_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"error":{"code":"3.08","messages":["Do not honor"],"recommended_message_for_user":"Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","authorization_type":"final","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"}},"error":{"code":"3.08","messages":["Do not honor"],"recommended_message_for_user":"Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","authorization_type":"final","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"}},"error":{"code":"3.08","messages":["Do not honor"],"recommended_message_for_user":"Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"05","flow":"frictionless","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"review"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"verify_url":"https://merchant.example/verify","redirect_url":"https://merchant.example/redirect","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleCardsResponseError":{"id":"components/examples/ExampleCardsResponseError","value":{"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"Double-check and correct payment details."}}},"components/examples/ExampleCardsResponseArn":{"id":"components/examples/ExampleCardsResponseArn","value":{"arn_codes":[{"arn_code":"24871153022084127852235","created_at":"2026-07-15 11:45:30","amount_refunded":100,"currency":"USD","transaction_status":"success"}]}},"components/examples/ExampleApmRequestInitPaymentPaypal":{"id":"components/examples/ExampleApmRequestInitPaymentPaypal","value":{"payment_method":"paypal-vault","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"USD","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentAlipay":{"id":"components/examples/ExampleApmRequestInitPaymentAlipay","value":{"payment_method":"alipay","order_id":"order_20251221_CNY_8900","amount":8900,"currency":"CNY","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_first_name":"Wei","customer_last_name":"Zhang","customer_phone":"+8613812345678","item_category":"digital_goods","billing_address":{"country":"CHN","city":"Shanghai","zip":"200000","line1":"123 Nanjing Road","line2":"Apt. 456"},"language":"en","ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"CNY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleApmRequestInitPaymentBlik":{"id":"components/examples/ExampleApmRequestInitPaymentBlik","value":{"payment_method":"blik","payment_method_flow":"direct","future_usage":{"payment_type":"unscheduled"},"payment_type_data":{"blik_code":"123456"},"order_id":"order_sub_20240401","amount":2999,"currency":"PLN","order_description":"Monthly Premium Plan","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"customer@example.pl","customer_first_name":"Nikola","customer_last_name":"Tesla","billing_address":{"country":"POL"},"ip_address":"178.12.34.56","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentBlikBnpl":{"id":"components/examples/ExampleApmRequestInitPaymentBlikBnpl","value":{"payment_method":"blik-bnpl","payment_method_flow":"redirect","order_id":"order_blik_pay_later_001","amount":50000,"currency":"PLN","order_description":"Order #blik_pay_later_001","customer_email":"buyer@example.pl","customer_first_name":"Jakub","customer_last_name":"Kowalski","ip_address":"83.25.101.14","platform":"WEB","billing_address":{"country":"POL"},"future_usage":{"payment_type":"one-time"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentBizum":{"id":"components/examples/ExampleApmRequestInitPaymentBizum","value":{"payment_method":"bizum","order_id":"order_20251021_EUR_400","amount":400,"currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2025-10-21 13:49:00","customer_account_id":"user_id_12345","customer_email":"test@merchant.example","customer_first_name":"Carlos","customer_last_name":"García","customer_phone":"+34700000000","item_category":"digital_goods","billing_address":{"country":"ESP","city":"Madrid","zip":"28001","line1":"Calle Gran Vía 123","line2":"Piso 4"},"language":"en","ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"ES2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleApmRequestInitPaymentBoleto":{"id":"components/examples/ExampleApmRequestInitPaymentBoleto","value":{"payment_method":"boleto","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","payment_method_flow":"redirect","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentCashapp":{"id":"components/examples/ExampleApmRequestInitPaymentCashapp","value":{"payment_method":"cashapp","order_id":"order_20260813_USD_1020","amount":1020,"currency":"USD","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2026-08-13 10:31:44","customer_account_id":"user_id_12345","customer_email":"example@example.com","customer_first_name":"Alex","customer_last_name":"Johnson","customer_phone":"+12025550123","billing_address":{"country":"USA","state":"NY","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"language":"en","ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2026","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentEfecty":{"id":"components/examples/ExampleApmRequestInitPaymentEfecty","value":{"payment_method":"efecty","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":10000,"currency":"COP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"COL","state":"Cundinamarca","city":"Bogotá","zip":"54321","line1":"Carrera 7 # 123","line2":"Apto 456"},"shipping_address":{"country":"COL","state":"Antioquia","city":"Medellín","zip":"12345","line1":"Calle 45 # 789","line2":"Unit 789"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"colombia_cc":"42141221"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentGcash":{"id":"components/examples/ExampleApmRequestInitPaymentGcash","value":{"payment_method":"gcash","order_id":"order_20251103_PHP_2575","amount":2575,"currency":"PHP","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2025-11-03 15:51:00","customer_account_id":"user_id_67890","customer_email":"example.user@example.com","customer_first_name":"Maria","customer_last_name":"Santos","customer_phone":"+639171234567","item_category":"digital_goods","billing_address":{"country":"PHL","city":"Manila","zip":"1000","line1":"123 Rizal Avenue","line2":"Unit 5B"},"language":"en","ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"PH2025","partner_id":"123989"},"return_url":"https://merchant.example"}},"components/examples/ExampleApmRequestInitPaymentIdeal":{"id":"components/examples/ExampleApmRequestInitPaymentIdeal","value":{"payment_method":"ideal","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentKlarnaNetwork":{"id":"components/examples/ExampleApmRequestInitPaymentKlarnaNetwork","value":{"payment_method":"klarna-network","order_id":"order_kln_001","amount":9900,"currency":"EUR","order_description":"Order #kln_001","order_date":"2026-05-19 10:31:44","customer_account_id":"user_id_67890","customer_email":"buyer@example.com","customer_first_name":"Emma","customer_last_name":"Johansson","customer_date_of_birth":"1990-03-15","customer_phone":"+46701234567","item_category":"physical_goods","billing_address":{"country":"SWE","state":"Stockholm","city":"Stockholm","zip":"111 57","line1":"Sveavägen 1","line2":"Apt. 12"},"shipping_address":{"country":"SWE","state":"Stockholm","city":"Stockholm","zip":"111 57","line1":"Sveavägen 1","line2":"Apt. 12"},"future_usage":{"payment_type":"one-time"},"payment_type_data":{"klarna_network_session_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.klarna_session_token_example","klarna_network_data":"{\"order_lines\":[{\"name\":\"Premium jacket\",\"quantity\":1,\"unit_price\":9900,\"total_amount\":9900}]}","sweden_pin":"19811228-9874","klarna_originators":[{"name":"SHOPIFY","session_reference":"shop-session-abc123","module_name":"shopify-plugin","module_version":"1.0.0"}]},"language":"en","ip_address":"82.115.34.21","platform":"WEB","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36","order_metadata":{"coupon_code":"SPRING2026","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/return"}},"components/examples/ExampleApmRequestInitPaymentMbway":{"id":"components/examples/ExampleApmRequestInitPaymentMbway","value":{"payment_method":"mbway","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"PRT"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestInitPaymentMercadopago":{"id":"components/examples/ExampleApmRequestInitPaymentMercadopago","value":{"payment_method":"mercadopago","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"argentina_dni":42243309},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentMobilepay":{"id":"components/examples/ExampleApmRequestInitPaymentMobilepay","value":{"payment_method":"mobilepay","order_id":"order_mp_001","amount":9900,"currency":"DKK","future_usage":{"payment_type":"one-time"},"order_description":"Order #mp_001","customer_email":"buyer@example.dk","customer_first_name":"Lars","customer_last_name":"Jensen","ip_address":"195.68.45.12","platform":"WEB","billing_address":{"country":"DNK"}}},"components/examples/ExampleApmRequestInitPaymentMultibanco":{"id":"components/examples/ExampleApmRequestInitPaymentMultibanco","value":{"payment_method":"multibanco","order_id":"order_abc123","amount":2490,"currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Order #abc123","order_date":"2026-04-23 10:31:44","customer_account_id":"user_id_abc123","customer_email":"buyer@example.pt","customer_first_name":"João","customer_last_name":"Silva","customer_phone":"+351912345678","billing_address":{"country":"PRT","city":"Lisboa","zip":"1250-096","line1":"Avenida da Liberdade 100","line2":"3º Esq."},"language":"en","ip_address":"178.12.34.56","platform":"WEB","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36","order_metadata":{"coupon_code":"PT2026","partner_id":"123989"}}},"components/examples/ExampleApmRequestInitPaymentOxxo":{"id":"components/examples/ExampleApmRequestInitPaymentOxxo","value":{"payment_method":"oxxo","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"MXN","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_email":"example@example.com","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"mexico_curp":"ZAZD801124MBSYQN13"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentOpenbanking":{"id":"components/examples/ExampleApmRequestInitPaymentOpenbanking","value":{"payment_method":"openbanking","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"DEU","state":"BE","city":"Berlin","zip":"10115","line1":"Alexanderplatz 1","line2":"Apartment 123"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentPixQr":{"id":"components/examples/ExampleApmRequestInitPaymentPixQr","value":{"payment_method":"pix-qr","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"summary":"Pix QR"},"components/examples/ExampleApmRequestInitPaymentPixAutomatico":{"id":"components/examples/ExampleApmRequestInitPaymentPixAutomatico","value":{"payment_method":"pix-automatico","order_id":"order_1234567890","amount":1000,"currency":"BRL","future_usage":{"payment_type":"recurring","billing_period":{"unit":"day","value":7},"max_amount":10000},"order_description":"Premium package","customer_email":"example@example.com","customer_first_name":"John","customer_last_name":"Doe","ip_address":"203.0.113.0","platform":"WEB","billing_address":{"country":"BRA"},"payment_type_data":{"brazil_cpf":"12345678901"}},"summary":"Pix Automático"},"components/examples/ExampleApmRequestInitPaymentPrzelewy24":{"id":"components/examples/ExampleApmRequestInitPaymentPrzelewy24","value":{"payment_method":"przelewy24","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"PLN","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentPse":{"id":"components/examples/ExampleApmRequestInitPaymentPse","value":{"payment_method":"pse","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":10000,"currency":"COP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"COL","state":"Cundinamarca","city":"Bogotá","zip":"54321","line1":"Carrera 7 # 123","line2":"Apto 456"},"shipping_address":{"country":"COL","state":"Antioquia","city":"Medellín","zip":"12345","line1":"Calle 45 # 789","line2":"Unit 789"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"colombia_cc":"42141221"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentSencillito":{"id":"components/examples/ExampleApmRequestInitPaymentSencillito","value":{"payment_method":"sencillito","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1000,"currency":"CLP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Isabella","customer_last_name":"Martinez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"123456","line1":"123 Main Street","line2":"Apartment 456"},"shipping_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"654321","line1":"789 Elm Street","line2":"Unit 789"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"chile_ci":"5633554V"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentServipag":{"id":"components/examples/ExampleApmRequestInitPaymentServipag","value":{"payment_method":"servipag","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1000,"currency":"CLP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Isabella","customer_last_name":"Martinez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"123456","line1":"123 Main Street","line2":"Apartment 456"},"shipping_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"654321","line1":"789 Elm Street","line2":"Unit 789"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"chile_ci":"5633554V"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentPix":{"id":"components/examples/ExampleApmRequestInitPaymentPix","value":{"payment_method":"pix","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentUpi":{"id":"components/examples/ExampleApmRequestInitPaymentUpi","value":{"payment_method":"upi","payment_method_flow":"redirect","order_id":"order_rec_001","amount":29900,"currency":"INR","order_description":"Monthly subscription","customer_email":"buyer@example.in","customer_first_name":"Arjun","customer_last_name":"Sharma","customer_phone":"+919876543210","ip_address":"103.21.56.78","platform":"WEB","billing_address":{"country":"IND","zip":"110001"},"future_usage":{"payment_type":"recurring","max_amount":99900,"billing_period":{"unit":"month","value":1}},"return_url":"https://merchant.example.com/return"}},"components/examples/ExampleApmRequestInitPaymentWebpay":{"id":"components/examples/ExampleApmRequestInitPaymentWebpay","value":{"payment_method":"webpay","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1000,"currency":"CLP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Isabella","customer_last_name":"Martinez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"123456","line1":"123 Main Street","line2":"Apartment 456"},"shipping_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"654321","line1":"789 Elm Street","line2":"Unit 789"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"chile_ci":"5633554V"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestInitPaymentWechatpay":{"id":"components/examples/ExampleApmRequestInitPaymentWechatpay","value":{"payment_method":"wechatpay","order_id":"order_20251221_CNY_8901","amount":8900,"currency":"CNY","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_first_name":"Li","customer_last_name":"Wang","customer_phone":"+8613812345678","item_category":"digital_goods","billing_address":{"country":"CHN","city":"Beijing","zip":"100000","line1":"456 Chang'an Avenue","line2":"Building 3"},"language":"en","ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"WX2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleApmRequestOneTimeProductPaypal":{"id":"components/examples/ExampleApmRequestOneTimeProductPaypal","value":{"payment_method":"paypal-vault","order_id":"f3g4h5i6-7j8k-90l1-m2n3-456op789qr12","product_id":"g4h5i6j7-k8l9-01m2-n345-op678qr901st","currency":"USD","order_description":"Platinum plan","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":10005,"line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":91191,"line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductAlipay":{"id":"components/examples/ExampleApmRequestOneTimeProductAlipay","value":{"payment_method":"alipay","order_id":"order_prod_20251221_CNY_001","product_id":"g4h5i6j7-k8l9-01m2-n345-op678qr901st","currency":"CNY","future_usage":{"payment_type":"one-time"},"order_description":"Platinum plan","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"test@merchant.example","customer_first_name":"Wei","customer_last_name":"Zhang","customer_phone":"+8613812345678","item_category":"digital_goods","billing_address":{"country":"CHN","city":"Shanghai","zip":"200000","line1":"123 Nanjing Road","line2":"Apt. 456"},"ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleApmRequestOneTimeProductBlik":{"id":"components/examples/ExampleApmRequestOneTimeProductBlik","value":{"payment_method":"blik","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"PLN","order_description":"Deluxe membership","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"MOB","user_agent":"Mozilla/5.0","payment_type_data":{"blik_code":"777111"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductBlikBnpl":{"id":"components/examples/ExampleApmRequestOneTimeProductBlikBnpl","value":{"payment_method":"blik-bnpl","payment_method_flow":"redirect","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"PLN","order_description":"Deluxe membership","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"buyer@example.pl","customer_first_name":"Jakub","customer_last_name":"Kowalski","customer_date_of_birth":"1988-11-21","customer_phone":"+48123456789","item_category":"digital_goods","billing_address":{"country":"POL","state":"MZ","city":"Warsaw","zip":"00-001","line1":"ul. Marszałkowska 1"},"ip_address":"83.25.101.14","platform":"WEB","user_agent":"Mozilla/5.0","future_usage":{"payment_type":"one-time"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductBoleto":{"id":"components/examples/ExampleApmRequestOneTimeProductBoleto","value":{"payment_method":"boleto","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","payment_method_flow":"redirect","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductEfecty":{"id":"components/examples/ExampleApmRequestOneTimeProductEfecty","value":{"payment_method":"efecty","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"COP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"COL","state":"Cundinamarca","city":"Bogotá","zip":"54321","line1":"Carrera 7 # 123","line2":"Apto 456"},"shipping_address":{"country":"COL","state":"Antioquia","city":"Medellín","zip":"12345","line1":"Calle 45 # 789","line2":"Unit 789"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"colombia_cc":"42141221"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductGcash":{"id":"components/examples/ExampleApmRequestOneTimeProductGcash","value":{"payment_method":"gcash","order_id":"order_prod_20251103_PHP_001","product_id":"g4h5i6j7-k8l9-01m2-n345-op678qr901st","currency":"PHP","future_usage":{"payment_type":"one-time"},"order_description":"Platinum plan","order_date":"2025-11-03 15:51:00","customer_account_id":"user_id_67890","customer_email":"example.user@example.com","customer_first_name":"Maria","customer_last_name":"Santos","customer_phone":"+639171234567","item_category":"digital_goods","billing_address":{"country":"PHL","city":"Manila","zip":"1000","line1":"123 Rizal Avenue","line2":"Unit 5B"},"ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example"}},"components/examples/ExampleApmRequestOneTimeProductIdeal":{"id":"components/examples/ExampleApmRequestOneTimeProductIdeal","value":{"payment_method":"ideal","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductKlarnaNetwork":{"id":"components/examples/ExampleApmRequestOneTimeProductKlarnaNetwork","value":{"payment_method":"klarna-network","order_id":"order_kln_prod_001","product_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2026-05-19 10:31:44","customer_account_id":"user_id_67890","customer_email":"buyer@example.com","customer_first_name":"Emma","customer_last_name":"Johansson","customer_date_of_birth":"1990-03-15","customer_phone":"+46701234567","item_category":"physical_goods","billing_address":{"country":"SWE","state":"Stockholm","city":"Stockholm","zip":"111 57","line1":"Sveavägen 1","line2":"Apt. 12"},"shipping_address":{"country":"SWE","state":"Stockholm","city":"Stockholm","zip":"111 57","line1":"Sveavägen 1","line2":"Apt. 12"},"payment_type_data":{"klarna_network_session_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.klarna_session_token_example","klarna_network_data":"{\"order_lines\":[{\"name\":\"Premium package\",\"quantity\":1,\"unit_price\":9900,\"total_amount\":9900}]}","sweden_pin":"19811228-9874","klarna_originators":[{"name":"SHOPIFY","session_reference":"shop-session-abc123","module_name":"shopify-plugin","module_version":"1.0.0"}]},"language":"en","ip_address":"82.115.34.21","platform":"WEB","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36","order_metadata":{"coupon_code":"SPRING2026","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/return"}},"components/examples/ExampleApmRequestOneTimeProductMbway":{"id":"components/examples/ExampleApmRequestOneTimeProductMbway","value":{"payment_method":"mbway","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"PRT"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"}}},"components/examples/ExampleApmRequestOneTimeProductMercadopago":{"id":"components/examples/ExampleApmRequestOneTimeProductMercadopago","value":{"payment_method":"mercadopago","order_id":"u4v5w6x7-8y9z-01a2-b3c4-567de890fg12","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"BRL","order_description":"Premium Gold membership","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1989-09-21","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":10005,"line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":91191,"line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"argentina_dni":42243309},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductMobilepay":{"id":"components/examples/ExampleApmRequestOneTimeProductMobilepay","value":{"payment_method":"mobilepay","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"DKK","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2026-06-10 10:31:44","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"buyer@example.dk","customer_first_name":"Lars","customer_last_name":"Jensen","customer_date_of_birth":"1985-03-15","customer_phone":"+4512345678","item_category":"digital_goods","billing_address":{"country":"DNK","city":"Copenhagen","zip":"1050","line1":"Vesterbrogade 1","line2":"2. tv"},"shipping_address":{"country":"DNK","city":"Copenhagen","zip":"1050","line1":"Vesterbrogade 1","line2":"2. tv"},"ip_address":"195.68.45.12","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"DK2026","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductMultibanco":{"id":"components/examples/ExampleApmRequestOneTimeProductMultibanco","value":{"payment_method":"multibanco","order_id":"order_product_abc123","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"EUR","order_description":"Order #abc123","order_date":"2026-04-23 10:31:44","customer_account_id":"user_id_abc123","customer_email":"buyer@example.pt","customer_first_name":"João","customer_last_name":"Silva","customer_phone":"+351912345678","item_category":"digital_goods","billing_address":{"country":"PRT","city":"Lisboa","zip":"1250-096","line1":"Avenida da Liberdade 100","line2":"3º Esq."},"language":"en","ip_address":"178.12.34.56","platform":"WEB","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36","order_metadata":{"coupon_code":"PT2026","partner_id":"123989"}}},"components/examples/ExampleApmRequestOneTimeProductOxxo":{"id":"components/examples/ExampleApmRequestOneTimeProductOxxo","value":{"payment_method":"oxxo","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"MXN","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"d4e5f6g7-h8i9-j0k1-234lmn567op8","customer_email":"example@example.com","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"mexico_curp":"ZAZD801124MBSYQN13"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductOpenbanking":{"id":"components/examples/ExampleApmRequestOneTimeProductOpenbanking","value":{"payment_method":"openbanking","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"EUR","order_description":"Premium package","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"DEU","state":"BE","city":"Berlin","zip":"10115","line1":"Alexanderplatz 1","line2":"Apartment 123"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductPixQr":{"id":"components/examples/ExampleApmRequestOneTimeProductPixQr","value":{"payment_method":"pix-qr","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"summary":"Product-based payment Pix QR"},"components/examples/ExampleApmRequestOneTimeProductPrzelewy24":{"id":"components/examples/ExampleApmRequestOneTimeProductPrzelewy24","value":{"payment_method":"przelewy24","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"PLN","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductPse":{"id":"components/examples/ExampleApmRequestOneTimeProductPse","value":{"payment_method":"pse","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"COP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"COL","state":"Cundinamarca","city":"Bogotá","zip":"54321","line1":"Carrera 7 # 123","line2":"Apto 456"},"shipping_address":{"country":"COL","state":"Antioquia","city":"Medellín","zip":"12345","line1":"Calle 45 # 789","line2":"Unit 789"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"colombia_cc":"42141221"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductSencillito":{"id":"components/examples/ExampleApmRequestOneTimeProductSencillito","value":{"payment_method":"sencillito","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"CLP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Isabella","customer_last_name":"Martinez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"123456","line1":"123 Main Street","line2":"Apartment 456"},"shipping_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"654321","line1":"789 Elm Street","line2":"Unit 789"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"chile_ci":"5633554V"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductServipag":{"id":"components/examples/ExampleApmRequestOneTimeProductServipag","value":{"payment_method":"servipag","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"CLP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Isabella","customer_last_name":"Martinez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"123456","line1":"123 Main Street","line2":"Apartment 456"},"shipping_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"654321","line1":"789 Elm Street","line2":"Unit 789"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"chile_ci":"5633554V"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductPix":{"id":"components/examples/ExampleApmRequestOneTimeProductPix","value":{"payment_method":"pix","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductUpi":{"id":"components/examples/ExampleApmRequestOneTimeProductUpi","value":{"payment_method":"upi","payment_method_flow":"direct","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"INR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+919876543210","item_category":"digital_goods","billing_address":{"country":"IND","state":"Maharashtra","city":"Mumbai","zip":"400001","line1":"123 Main St.","line2":"Apt. 123"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","future_usage":{"payment_type":"unscheduled"},"payment_type_data":{"india_vpa":"1234567890@abc"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductWebpay":{"id":"components/examples/ExampleApmRequestOneTimeProductWebpay","value":{"payment_method":"webpay","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"CLP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Isabella","customer_last_name":"Martinez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"123456","line1":"123 Main Street","line2":"Apartment 456"},"shipping_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"654321","line1":"789 Elm Street","line2":"Unit 789"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"chile_ci":"5633554V"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestOneTimeProductWechatpay":{"id":"components/examples/ExampleApmRequestOneTimeProductWechatpay","value":{"payment_method":"wechatpay","order_id":"order_prod_20251221_CNY_002","product_id":"g4h5i6j7-k8l9-01m2-n345-op678qr901st","currency":"CNY","future_usage":{"payment_type":"one-time"},"order_description":"Platinum plan","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"test@merchant.example","customer_first_name":"Li","customer_last_name":"Wang","customer_phone":"+8613812345678","item_category":"digital_goods","billing_address":{"country":"CHN","city":"Beijing","zip":"100000","line1":"456 Chang'an Avenue","line2":"Building 3"},"ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"}},"components/examples/ExampleApmRequestSubscriptionPaymentPaypal":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentPaypal","value":{"payment_method":"paypal-vault","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"USD","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":10005,"line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":91191,"line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestSubscriptionPaymentAlipay":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentAlipay","value":{"payment_method":"alipay","order_id":"order_sub_init_20251221_CNY_001","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"CNY","future_usage":{"payment_type":"unscheduled"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_email":"test@merchant.example","customer_first_name":"Wei","customer_last_name":"Zhang","customer_date_of_birth":"1988-11-21","customer_phone":"+8613800138000","item_category":"digital_goods","billing_address":{"country":"CHN","state":"11","city":"Beijing","zip":"100000","line1":"123 Wangfujing Street","line2":"Building A"},"shipping_address":{"country":"CHN","state":"31","city":"Shanghai","zip":"200000","line1":"777 Nanjing Road","line2":"Floor 5"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","order_metadata":{"coupon_code":"CNY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestSubscriptionPaymentBlik":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentBlik","value":{"payment_method":"blik","order_id":"order_sub_init_20240501","product_id":"b2c3d4e5-f6a7-4890-b123-456789abcdef","currency":"PLN","payment_method_flow":"direct","future_usage":{"payment_type":"unscheduled"},"payment_type_data":{"blik_code":"123456"},"order_description":"Monthly Premium Plan","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"customer@example.pl","billing_address":{"country":"POL"},"ip_address":"178.12.34.56","platform":"WEB","user_agent":"Mozilla/5.0"}},"components/examples/ExampleApmRequestSubscriptionPaymentGcash":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentGcash","value":{"payment_method":"gcash","order_id":"order_sub_init_20251103_PHP_001","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"PHP","future_usage":{"payment_type":"unscheduled"},"order_description":"Premium package","order_date":"2025-11-03 15:51:00","customer_email":"example.user@example.com","customer_first_name":"Maria","customer_last_name":"Santos","customer_date_of_birth":"1990-05-15","customer_phone":"+639171234567","item_category":"digital_goods","billing_address":{"country":"PHL","state":"NCR","city":"Manila","zip":"1000","line1":"123 Rizal Avenue","line2":"Unit 5B"},"shipping_address":{"country":"PHL","state":"00","city":"Quezon City","zip":"1100","line1":"456 Commonwealth Avenue","line2":"Floor 10"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","order_metadata":{"coupon_code":"PH2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example"}},"components/examples/ExampleApmRequestSubscriptionKlarnaNetwork":{"id":"components/examples/ExampleApmRequestSubscriptionKlarnaNetwork","value":{"payment_method":"klarna-network","order_id":"order_kln_sub_001","product_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","currency":"EUR","future_usage":{"payment_type":"recurring"},"order_description":"Monthly Premium subscription","order_date":"2026-05-19 10:31:44","customer_account_id":"user_id_67890","customer_email":"buyer@example.com","customer_first_name":"Emma","customer_last_name":"Johansson","customer_date_of_birth":"1990-03-15","customer_phone":"+46701234567","item_category":"digital_goods","billing_address":{"country":"SWE","state":"Stockholm","city":"Stockholm","zip":"111 57","line1":"Sveavägen 1","line2":"Apt. 12"},"shipping_address":{"country":"SWE","state":"Stockholm","city":"Stockholm","zip":"111 57","line1":"Sveavägen 1","line2":"Apt. 12"},"payment_type_data":{"klarna_network_session_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.klarna_session_token_example","klarna_network_data":"{\"order_lines\":[{\"name\":\"Monthly Premium subscription\",\"quantity\":1,\"unit_price\":9900,\"total_amount\":9900}]}","sweden_pin":"19811228-9874","klarna_originators":[{"name":"SHOPIFY","session_reference":"shop-session-abc123","module_name":"shopify-plugin","module_version":"1.0.0"}]},"language":"en","ip_address":"82.115.34.21","platform":"WEB","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36","order_metadata":{"subscription_id":"sub_12345","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/return"}},"components/examples/ExampleApmRequestSubscriptionPaymentMbway":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentMbway","value":{"payment_method":"mbway","order_id":"order_sub_init_20251221_EUR_001","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"EUR","future_usage":{"payment_type":"recurring"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"João","customer_last_name":"Silva","customer_date_of_birth":"1988-11-21","customer_phone":"+351912345678","item_category":"digital_goods","billing_address":{"country":"PRT","state":"11","city":"Lisbon","zip":"1000-001","line1":"123 Rua Augusta","line2":"Floor 2"},"shipping_address":{"country":"PRT","state":"11","city":"Porto","zip":"4000-001","line1":"777 Avenida da Boavista","line2":"Apt. 5B"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","order_metadata":{"coupon_code":"EUR2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestSubscriptionPaymentMercadopago":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentMercadopago","value":{"payment_method":"mercadopago","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1989-09-21","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":10005,"line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":91191,"line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"argentina_dni":42243309},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestSubscriptionPaymentPixAutomatico":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentPixAutomatico","value":{"payment_method":"pix-automatico","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","future_usage":{"max_amount":12000},"order_description":"Premium package","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","ip_address":"203.0.113.0","platform":"WEB","billing_address":{"country":"BRA"},"payment_type_data":{"brazil_cpf":"23100299900"}},"summary":"Subscription payment Pix Automático"},"components/examples/ExampleApmRequestSubscriptionPaymentPix":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentPix","value":{"payment_method":"pix","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestSubscriptionPaymentUpi":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentUpi","value":{"payment_method":"upi","payment_method_flow":"redirect","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"INR","future_usage":{"payment_type":"recurring","max_amount":99900},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1989-09-21","customer_phone":"+919876543210","item_category":"digital_goods","billing_address":{"country":"IND","state":"Maharashtra","city":"Mumbai","zip":"400001","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"IND","state":"Karnataka","city":"Bengaluru","zip":"560001","line1":"No. 1, MG Road","line2":"Near Brigade Road Junction"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmRequestSubscriptionPaymentWechatpay":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentWechatpay","value":{"payment_method":"wechatpay","order_id":"order_sub_init_20251221_CNY_002","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"CNY","future_usage":{"payment_type":"unscheduled"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_email":"test@merchant.example","customer_first_name":"Li","customer_last_name":"Wang","customer_date_of_birth":"1988-11-21","customer_phone":"+8613900139000","item_category":"digital_goods","billing_address":{"country":"CHN","state":"44","city":"Guangzhou","zip":"510000","line1":"456 Tianhe Road","line2":"Tower B"},"shipping_address":{"country":"CHN","state":"44","city":"Shenzhen","zip":"518000","line1":"888 Shennan Avenue","line2":"Unit 1001"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","order_metadata":{"coupon_code":"CNY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"}},"components/examples/ExampleApmResponsePaypal":{"id":"components/examples/ExampleApmResponsePaypal","value":{"order":{"method":"paypal-vault","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"USD","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"paypal-vault","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"USD","status":"processing","type":"pay"},{"method":"paypal-vault","id":"another_unique_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"USD","status":"success","type":"refund"}],"pay_form":{"script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseAlipay":{"id":"components/examples/ExampleApmResponseAlipay","value":{"order":{"method":"alipay","order_id":"order_20251221_CNY_8900","created_at":"2025-10-20 16:28:25","updated_at":"2025-10-20 16:28:26","amount":8900,"currency":"CNY","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","ip_address":"8.8.8.8"},"transactions":[{"method":"alipay","id":"175f83e6-665d-49f2-b6f0-836690ea7e1e","created_at":"2025-10-20 16:28:25","amount":8900,"currency":"CNY","status":"processing","type":"pay"},{"method":"alipay","id":"a641818f-71a7-4bca-9402-3e9b7d4f0123","created_at":"2025-10-20 17:00:00","amount":500,"currency":"CNY","status":"success","type":"refund"}],"pay_form":{"return_url":"https://simulator-ui-stage.boku.com/redirect/cb17a7e6-6c4e-40a9-b3e9-f50e9d7d9d04","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"CNY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseBlik":{"id":"components/examples/ExampleApmResponseBlik","value":{"order":{"method":"blik","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"PLN","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"blik","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"PLN","status":"processing","type":"pay"},{"method":"blik","id":"another_unique_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"PLN","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseBlikBnpl":{"id":"components/examples/ExampleApmResponseBlikBnpl","value":{"order":{"method":"blik-bnpl","order_id":"order_blik_pay_later_001","created_at":"2026-06-11 10:31:44","updated_at":"2026-06-11 10:31:44","amount":50000,"currency":"PLN","order_description":"Order #blik_pay_later_001","status":"processing","customer_email":"buyer@example.pl","ip_address":"83.25.101.14"},"transactions":[],"pay_form":{"token":"pft1ymnx6gq32ej3dvr9p45w","return_url":"https://e.blikpay.pl/blikweb/transaction/transaction_init/","script_url":""}}},"components/examples/ExampleApmResponseBizum":{"id":"components/examples/ExampleApmResponseBizum","value":{"order":{"method":"bizum","order_id":"order_20251021_EUR_400","created_at":"2025-10-21 13:49:05","updated_at":"2025-10-21 13:49:19","amount":400,"currency":"EUR","order_description":"Premium package","status":"processing","customer_account_id":"user_id_12345","customer_email":"test@merchant.example","ip_address":"8.8.8.8"},"transactions":[{"method":"bizum","id":"06ce84ca-cd5d-42a5-adc9-19dba107036f","created_at":"2025-10-21 13:49:05","amount":400,"currency":"EUR","status":"processing","type":"pay"},{"method":"bizum","id":"c863151b-9d3e-7ade-b624-5g9f9f6h2345","created_at":"2025-10-21 14:20:00","amount":50,"currency":"EUR","status":"success","type":"refund"}],"pay_form":{"script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"ES2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseBoleto":{"id":"components/examples/ExampleApmResponseBoleto","value":{"order":{"method":"boleto","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"BRL","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"boleto","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"BRL","status":"processing","type":"pay"},{"method":"boleto","id":"another_unique_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"BRL","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"payment_type_data":{"amount":107.51,"currency":"BRL","expiration_date":"2025-06-04","image_url":"https://payment-provider.example/transaction/abc123","number":"3419109107005633044159101318002","type":"CUSTOM"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseCashapp":{"id":"components/examples/ExampleApmResponseCashapp","value":{"order":{"method":"cashapp","order_id":"order_20260813_USD_1020","created_at":"2026-08-13 10:31:44","updated_at":"2026-08-13 10:31:58","amount":1020,"currency":"USD","order_description":"Premium package","status":"processing","customer_account_id":"user_id_12345","customer_email":"example@example.com","ip_address":"8.8.8.8"},"transactions":[{"method":"cashapp","id":"06ce84ca-cd5d-42a5-adc9-19dba107036f","created_at":"2026-08-13 10:31:44","amount":1020,"currency":"USD","status":"processing","type":"pay"},{"method":"cashapp","id":"c863151b-9d3e-7ade-b624-5g9f9f6h2345","created_at":"2026-08-13 11:20:00","amount":50,"currency":"USD","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2026","partner_id":"123989"}}},"components/examples/ExampleApmResponseEfecty":{"id":"components/examples/ExampleApmResponseEfecty","value":{"order":{"method":"efecty","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-21 11:21:30","updated_at":"2025-12-21 12:00:00","amount":10000,"currency":"COP","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"efecty","id":"unique_transaction_id_1","created_at":"2025-12-21 11:21:30","amount":5000,"currency":"COP","status":"processing","type":"pay"},{"method":"efecty","id":"unique_transaction_id_2","created_at":"2025-12-21 11:30:00","amount":5000,"currency":"COP","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseGcash":{"id":"components/examples/ExampleApmResponseGcash","value":{"order":{"method":"gcash","order_id":"order_20251103_PHP_2575","created_at":"2025-11-03 15:51:59","updated_at":"2025-11-03 15:52:10","amount":2575,"currency":"PHP","order_description":"Premium package","status":"processing","customer_account_id":"user_id_67890","customer_email":"example.user@example.com","ip_address":"8.8.8.8"},"transactions":[{"method":"gcash","id":"079c8d60-b9eb-4976-be49-e92c8e19a05d","created_at":"2025-11-03 15:51:59","amount":2575,"currency":"PHP","status":"processing","type":"pay"},{"method":"gcash","id":"d974262c-ae4f-8bef-c735-6h0g0g7i3456","created_at":"2025-11-03 16:45:00","amount":100,"currency":"PHP","status":"success","type":"refund"}],"pay_form":{"return_url":"https://g.alipayplus.com/link/redirect/auto/gotourl?url=https%3A%2F%2Fm.gcash.com%2F","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"PH2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseIdeal":{"id":"components/examples/ExampleApmResponseIdeal","value":{"order":{"method":"ideal","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"EUR","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"ideal","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"EUR","status":"processing","type":"pay"},{"method":"ideal","id":"another_id_here","created_at":"2025-12-28 12:00:00","amount":50,"currency":"EUR","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseKlarnaNetwork":{"id":"components/examples/ExampleApmResponseKlarnaNetwork","value":{"order":{"amount":9900,"currency":"EUR","order_id":"order_kln_001","status":"processing","method":"klarna-network","customer_account_id":"user_id_67890","customer_email":"buyer@example.com","ip_address":"82.115.34.21","order_description":"Order #kln_001","created_at":"2026-05-19 10:31:44","updated_at":"2026-05-19 10:31:44"},"pay_form":{"token":"pft1ymnx6gq32ej3dvr9p45w","return_url":"https://pay.klarna.com/eu/payments/...","script_url":""},"transactions":[],"order_metadata":{"coupon_code":"SPRING2026","partner_id":"123989"}}},"components/examples/ExampleApmResponseMbway":{"id":"components/examples/ExampleApmResponseMbway","value":{"order":{"method":"mbway","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"EUR","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"mbway","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"EUR","status":"processing","type":"pay"}],"pay_form":{"return_url":"https://example.com/?return"}}},"components/examples/ExampleApmResponseMercadopago":{"id":"components/examples/ExampleApmResponseMercadopago","value":{"order":{"method":"mercadopago","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"BRL","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"mercadopago","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"BRL","status":"processing","type":"pay"},{"method":"mercadopago","id":"another_unique_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"BRL","status":"success","type":"refund"}],"pay_form":{"return_url":"https://example.com/?return"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseMobilepay":{"id":"components/examples/ExampleApmResponseMobilepay","value":{"order":{"method":"mobilepay","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2026-06-10 10:31:44","updated_at":"2026-06-10 10:31:45","amount":9900,"currency":"DKK","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"buyer@example.dk","ip_address":"195.68.45.12"},"transactions":[{"method":"mobilepay","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-06-10 10:31:44","amount":9900,"currency":"DKK","status":"processing","type":"pay"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"DK2026","partner_id":"123989"}}},"components/examples/ExampleApmResponseMultibanco":{"id":"components/examples/ExampleApmResponseMultibanco","value":{"order":{"method":"multibanco","order_id":"order_abc123","created_at":"2026-04-23 10:31:44","updated_at":"2026-04-23 10:31:44","amount":2490,"currency":"EUR","order_description":"Order #abc123","status":"processing","customer_email":"buyer@example.pt","ip_address":"178.12.34.56"},"transactions":[{"method":"multibanco","id":"4a8d40dc-6935-4cd2-bcde-02beab46f46c","created_at":"2026-04-23 10:31:44","amount":2490,"currency":"EUR","status":"processing","type":"pay"},{"method":"multibanco","id":"b7e2c91a-4f63-48d1-a902-1c8d5e6f7a20","created_at":"2026-04-24 09:15:00","amount":500,"currency":"EUR","status":"success","type":"refund"}],"payment_type_data":{"type":"multibanco","entity":"24000","reference":"256309828","reference_expiration":"2026-04-24T10:31:44Z"},"order_metadata":{"coupon_code":"PT2026","partner_id":"123989"}}},"components/examples/ExampleApmResponseOxxo":{"id":"components/examples/ExampleApmResponseOxxo","value":{"order":{"method":"oxxo","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"MXN","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"oxxo","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"MXN","status":"processing","type":"pay"},{"method":"oxxo","id":"another_transaction_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"MXN","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseOpenbanking":{"id":"components/examples/ExampleApmResponseOpenbanking","value":{"order":{"method":"openbanking","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"EUR","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","ip_address":"203.0.113.0"},"transactions":[{"method":"openbanking","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"EUR","status":"processing","type":"pay"},{"method":"openbanking","id":"another_transaction_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"EUR","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/transaction/abc123","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponsePixQr":{"id":"components/examples/ExampleApmResponsePixQr","value":{"order":{"method":"pix-qr","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"BRL","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"pix-qr","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"BRL","status":"processing","type":"pay"},{"method":"pix-qr","id":"another_unique_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"BRL","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"payment_type_data":{"qr_code_value":"00020101021226890014br.gov.bcb.pix2563pix.example.com/qr/v2/....","qr_code_expiration_date":"2025-12-28 13:00:00"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"summary":"Pix QR"},"components/examples/ExampleApmResponsePixAutomatico":{"id":"components/examples/ExampleApmResponsePixAutomatico","value":{"order":{"method":"pix-automatico","order_id":"order_1234567890","created_at":"2026-04-10 11:36:45","updated_at":"2026-04-10 11:36:46","amount":1000,"currency":"BRL","order_description":"Premium package","status":"processing","customer_account_id":"customer_account_id","customer_email":"example@example.com","customer_first_name":"John","customer_last_name":"Doe","ip_address":"203.0.113.0"},"pay_form":{"return_url":"https://payment-provider.example/return","script_url":""},"transactions":[{"method":"pix-automatico","id":"175f83e6-665d-49f2-b6f0-836690ea7a1b","created_at":"2026-04-10 11:36:45","amount":1000,"currency":"BRL","status":"processing","type":"pay"}],"payment_type_data":{"qr_code_value":"00020101021226780014br.gov.bcb.pix2563pix.example.com/qr/v2/cobv/...","qr_code_expiration_date":"2026-04-10 12:36:45"}},"summary":"Pix Automático"},"components/examples/ExampleApmResponsePrzelewy24":{"id":"components/examples/ExampleApmResponsePrzelewy24","value":{"order":{"method":"przelewy24","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"PLN","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"przelewy24","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"PLN","status":"processing","type":"pay"},{"method":"przelewy24","id":"another_transaction_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"PLN","status":"success","type":"refund"}],"pay_form":{"return_url":"https://sandbox.przelewy24.pl/trnRequest/example","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponsePse":{"id":"components/examples/ExampleApmResponsePse","value":{"order":{"method":"pse","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-21 11:21:30","updated_at":"2025-12-21 12:00:00","amount":10000,"currency":"COP","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"pse","id":"unique_transaction_id_1","created_at":"2025-12-21 11:21:30","amount":5000,"currency":"COP","status":"processing","type":"pay"},{"method":"pse","id":"unique_transaction_id_2","created_at":"2025-12-21 11:30:00","amount":5000,"currency":"COP","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseSencillito":{"id":"components/examples/ExampleApmResponseSencillito","value":{"order":{"method":"sencillito","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-21 11:21:30","updated_at":"2025-12-21 12:00:00","amount":1000,"currency":"CLP","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"sencillito","id":"unique_transaction_id_1","created_at":"2025-12-21 11:21:30","amount":500,"currency":"CLP","status":"processing","type":"pay"},{"method":"sencillito","id":"unique_transaction_id_2","created_at":"2025-12-21 11:30:00","amount":500,"currency":"CLP","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseServipag":{"id":"components/examples/ExampleApmResponseServipag","value":{"order":{"method":"servipag","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-21 11:21:30","updated_at":"2025-12-21 12:00:00","amount":1000,"currency":"CLP","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"servipag","id":"unique_transaction_id_1","created_at":"2025-12-21 11:21:30","amount":500,"currency":"CLP","status":"processing","type":"pay"},{"method":"servipag","id":"unique_transaction_id_2","created_at":"2025-12-21 11:30:00","amount":500,"currency":"CLP","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponsePix":{"id":"components/examples/ExampleApmResponsePix","value":{"order":{"method":"pix","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"BRL","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"pix","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"BRL","status":"processing","type":"pay"},{"method":"pix","id":"another_unique_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"BRL","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseUpi":{"id":"components/examples/ExampleApmResponseUpi","value":{"order":{"method":"upi","order_id":"order_rec_001","created_at":"2026-05-18 10:31:44","updated_at":"2026-05-18 10:31:44","amount":29900,"currency":"INR","order_description":"Monthly subscription","status":"processing","customer_email":"buyer@example.in","ip_address":"103.21.56.78"},"pay_form":{"token":"pftlymnx6gq32ej3dvr9p45w","return_url":"https://merchant.example.com/return","script_url":""},"payment_type_data":{"deep_link_value":"upi://mandate?pa=merchant@upi&pn=MerchantName&tr=pay_KfyQIVi7wcL8Po&tn=Monthly+subscription"},"transactions":[]}},"components/examples/ExampleApmResponseWebpay":{"id":"components/examples/ExampleApmResponseWebpay","value":{"order":{"method":"webpay","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-21 11:21:30","updated_at":"2025-12-21 12:00:00","amount":1000,"currency":"CLP","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"webpay","id":"unique_transaction_id_1","created_at":"2025-12-21 11:21:30","amount":500,"currency":"CLP","status":"processing","type":"pay"},{"method":"webpay","id":"unique_transaction_id_2","created_at":"2025-12-21 11:30:00","amount":500,"currency":"CLP","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseWechatpay":{"id":"components/examples/ExampleApmResponseWechatpay","value":{"order":{"method":"wechatpay","order_id":"order_20251221_CNY_8901","created_at":"2025-10-20 16:17:41","updated_at":"2025-10-20 16:17:42","amount":8900,"currency":"CNY","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","ip_address":"8.8.8.8"},"transactions":[{"method":"wechatpay","id":"4a8d40dc-6935-4cd2-b6f0-836690ea7e1e","created_at":"2025-10-20 16:17:41","amount":8900,"currency":"CNY","status":"processing","type":"pay"},{"method":"wechatpay","id":"b752929e-82b8-5cda-a513-4f8e8e5g1234","created_at":"2025-10-20 17:30:00","amount":600,"currency":"CNY","status":"success","type":"refund"}],"pay_form":{"return_url":"https://simulator-ui-stage.boku.com/redirect/6c1bd3c5-eb17-4c27-be88-b7d0fd849a45","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"WX2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestRecurringPaypal":{"id":"components/examples/ExampleApmRequestRecurringPaypal","value":{"payment_method":"paypal-vault","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestRecurringAlipay":{"id":"components/examples/ExampleApmRequestRecurringAlipay","value":{"payment_method":"alipay","token":"ffb850ff6d134cab887fb1da5550cd758f66","order_id":"order_recur_20251221_CNY_001","amount":8900,"currency":"CNY","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_phone":"+8613812345678","language":"en","ip_address":"8.8.8.8","platform":"WEB","order_metadata":{"coupon_code":"CNY2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestRecurringBlik":{"id":"components/examples/ExampleApmRequestRecurringBlik","value":{"payment_method":"blik","token":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","order_id":"charge_sub_20240501","amount":2999,"currency":"PLN","order_description":"Monthly Premium Plan - May","customer_email":"customer@example.pl","ip_address":"178.12.34.56","platform":"WEB"}},"components/examples/ExampleApmRequestRecurringGcash":{"id":"components/examples/ExampleApmRequestRecurringGcash","value":{"payment_method":"gcash","token":"5hc1041dh9458dhdeee7e13g0e216i22i6dei8gee1g262gi71e73088907hggffhh01317hde8id2f48d662f27i4dg5e63fi522","order_id":"order_recur_20251103_PHP_001","amount":2575,"currency":"PHP","order_description":"Premium package","order_date":"2025-11-03 16:10:00","customer_account_id":"user_id_67890","customer_email":"example.user@example.com","customer_date_of_birth":"1990-05-15","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"subscription_id":"sub_12345","partner_id":"123989"}}},"components/examples/ExampleApmRequestRecurringKlarnaNetwork":{"id":"components/examples/ExampleApmRequestRecurringKlarnaNetwork","value":{"payment_method":"klarna-network","token":"5hc1041dh9458dhdeee7e13g0e216i22i6dei8gee1g262gi71e73088907hggffhh01317hde8id2f48d662f27i4dg5e63fi522","order_id":"order_kln_recur_001","amount":9900,"currency":"EUR","order_description":"Monthly subscription","order_date":"2026-05-19 11:00:00","customer_account_id":"user_id_67890","customer_email":"buyer@example.com","customer_first_name":"Emma","customer_last_name":"Johansson","customer_date_of_birth":"1990-03-15","payment_type_data":{"klarna_network_session_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.klarna_session_token_example","klarna_network_data":"{\"order_lines\":[{\"name\":\"Monthly subscription\",\"quantity\":1,\"unit_price\":9900,\"total_amount\":9900}]}","klarna_originators":[{"name":"SHOPIFY","session_reference":"shop-session-abc123","module_name":"shopify-plugin","module_version":"1.0.0"}]},"language":"en","ip_address":"82.115.34.21","platform":"WEB","order_metadata":{"subscription_id":"sub_12345","partner_id":"123989"},"fail_url":"https://merchant.example/fail"}},"components/examples/ExampleApmRequestRecurringMbway":{"id":"components/examples/ExampleApmRequestRecurringMbway","value":{"payment_method":"mbway","token":"ffb850ff6d134cab887fb1da5550cd758f66","order_id":"order_recur_20251221_EUR_001","amount":1020,"currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_phone":"+351912345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"EUR2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestRecurringMercadopago":{"id":"components/examples/ExampleApmRequestRecurringMercadopago","value":{"payment_method":"mercadopago","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestRecurringPixAutomatico":{"id":"components/examples/ExampleApmRequestRecurringPixAutomatico","value":{"payment_method":"pix-automatico","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2026-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2026","partner_id":"123989"}},"summary":"Pix Automático"},"components/examples/ExampleApmRequestRecurringPix":{"id":"components/examples/ExampleApmRequestRecurringPix","value":{"payment_method":"pix","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"summary":"SmartPix"},"components/examples/ExampleApmRequestRecurringUpi":{"id":"components/examples/ExampleApmRequestRecurringUpi","value":{"payment_method":"upi","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"INR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestRecurringWechatpay":{"id":"components/examples/ExampleApmRequestRecurringWechatpay","value":{"payment_method":"wechatpay","token":"12e07128df5f4f5faaddaacc89765432","order_id":"order_recur_20251221_CNY_002","amount":8900,"currency":"CNY","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_phone":"+8613812345678","language":"en","ip_address":"8.8.8.8","order_metadata":{"coupon_code":"WX2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestOneTimeProductRecurringPaypal":{"id":"components/examples/ExampleApmRequestOneTimeProductRecurringPaypal","value":{"payment_method":"paypal-vault","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"u4v5w6x7-8y9z-01a2-b3c4-567de890fg12","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"EUR","order_description":"Exclusive package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}}},"components/examples/ExampleApmRequestOneTimeProductRecurringAlipay":{"id":"components/examples/ExampleApmRequestOneTimeProductRecurringAlipay","value":{"payment_method":"alipay","token":"2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"order_prod_recur_20251221_CNY_001","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"CNY","order_description":"Exclusive package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_date_of_birth":"1988-11-21","customer_phone":"+8613812345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}}},"components/examples/ExampleApmRequestOneTimeProductRecurringBlik":{"id":"components/examples/ExampleApmRequestOneTimeProductRecurringBlik","value":{"payment_method":"blik","token":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","order_id":"charge_sub_product_20240501","product_id":"b2c3d4e5-f6a7-4890-b123-456789abcdef","currency":"PLN","order_description":"Monthly Premium Plan - May","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"customer@example.pl","ip_address":"178.12.34.56","platform":"WEB"}},"components/examples/ExampleApmRequestOneTimeProductRecurringGcash":{"id":"components/examples/ExampleApmRequestOneTimeProductRecurringGcash","value":{"payment_method":"gcash","token":"2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"order_prod_recur_20251103_PHP_001","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"PHP","order_description":"Exclusive package","order_date":"2025-11-03 15:51:00","customer_account_id":"user_id_67890","customer_email":"example.user@example.com","customer_date_of_birth":"1990-05-15","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}}},"components/examples/ExampleApmRequestRecurringOneTimeProductMbway":{"id":"components/examples/ExampleApmRequestRecurringOneTimeProductMbway","value":{"payment_method":"mbway","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"order_recur_otp_20251221_EUR_001","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","customer_phone":"+351912345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"EUR2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestOneTimeProductRecurringMercadopago":{"id":"components/examples/ExampleApmRequestOneTimeProductRecurringMercadopago","value":{"payment_method":"mercadopago","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"u4v5w6x7-8y9z-01a2-b3c4-567de890fg12","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"BRL","order_description":"Exclusive package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}}},"components/examples/ExampleApmRequestOneTimeProductRecurringUpi":{"id":"components/examples/ExampleApmRequestOneTimeProductRecurringUpi","value":{"payment_method":"upi","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"u4v5w6x7-8y9z-01a2-b3c4-567de890fg12","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"INR","order_description":"Exclusive package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}}},"components/examples/ExampleApmRequestOneTimeProductRecurringPixAutomatico":{"id":"components/examples/ExampleApmRequestOneTimeProductRecurringPixAutomatico","value":{"payment_method":"pix-automatico","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2026-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}},"summary":"Product-based recurring Pix Automático"},"components/examples/ExampleApmRequestOneTimeProductRecurringPix":{"id":"components/examples/ExampleApmRequestOneTimeProductRecurringPix","value":{"payment_method":"pix","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}},"summary":"Product-based recurring SmartPix"},"components/examples/ExampleApmRequestOneTimeProductRecurringWechatpay":{"id":"components/examples/ExampleApmRequestOneTimeProductRecurringWechatpay","value":{"payment_method":"wechatpay","token":"3fa0829bf7236bfbcc5c91e8c094g00g4bcg6ecc9e040eg59c51866785feeddff89195fbc6gb0d26b440d05g2be3c41dg300","order_id":"order_prod_recur_20251221_CNY_002","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"CNY","order_description":"Exclusive package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_date_of_birth":"1988-11-21","customer_phone":"+8613812345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}}},"components/examples/ExampleApmRequestSubscriptionPaymentRecurringPaypal":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentRecurringPaypal","value":{"payment_method":"paypal-vault","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestSubscriptionPaymentRecurringAlipay":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentRecurringAlipay","value":{"payment_method":"alipay","token":"2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"order_sub_20251221_CNY_001","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"CNY","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_date_of_birth":"1988-11-21","customer_phone":"+8613812345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestSubscriptionPaymentRecurringBlik":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentRecurringBlik","value":{"payment_method":"blik","token":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","order_id":"charge_sub_product_20240501","product_id":"b2c3d4e5-f6a7-4890-b123-456789abcdef","currency":"PLN","order_description":"Monthly Premium Plan - May","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"customer@example.pl","ip_address":"178.12.34.56","platform":"WEB"}},"components/examples/ExampleApmRequestSubscriptionPaymentRecurringGcash":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentRecurringGcash","value":{"payment_method":"gcash","token":"2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"order_sub_20251103_PHP_001","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"PHP","order_description":"Premium package","order_date":"2025-11-03 15:51:00","customer_account_id":"user_id_67890","customer_email":"example.user@example.com","customer_date_of_birth":"1990-05-15","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"PH2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestRecurringSubscriptionPaymentMbway":{"id":"components/examples/ExampleApmRequestRecurringSubscriptionPaymentMbway","value":{"payment_method":"mbway","token":"2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"order_sub_recur_20251221_EUR_001","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","customer_phone":"+351912345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"EUR2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestSubscriptionPaymentRecurringMercadopago":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentRecurringMercadopago","value":{"payment_method":"mercadopago","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestSubscriptionPaymentRecurringPixAutomatico":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentRecurringPixAutomatico","value":{"payment_method":"pix-automatico","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2026-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2026","partner_id":"123989"}},"summary":"Subscription Pix Automático"},"components/examples/ExampleApmRequestSubscriptionPaymentRecurringPix":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentRecurringPix","value":{"payment_method":"pix","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"summary":"Subscription SmartPix"},"components/examples/ExampleApmRequestSubscriptionPaymentRecurringUpi":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentRecurringUpi","value":{"payment_method":"upi","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"INR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestSubscriptionPaymentRecurringWechatpay":{"id":"components/examples/ExampleApmRequestSubscriptionPaymentRecurringWechatpay","value":{"payment_method":"wechatpay","token":"3fa0829bf7236bfbcc5c91e8c094g00g4bcg6ecc9e040eg59c51866785feeddff89195fbc6gb0d26b440d05g2be3c41dg300","order_id":"order_sub_20251221_CNY_002","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"CNY","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_date_of_birth":"1988-11-21","customer_phone":"+8613812345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmResponseRecurring":{"id":"components/examples/ExampleApmResponseRecurring","value":{"order":{"method":"paypal-vault","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"USD","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"ip_address":"203.0.113.0","provider_data":{"billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"payer":{"first_name":"John","last_name":"Doe","email":"example@example.com"},"merchant":{"account_id":"78UQ777KUJAQN"}},"transactions":[{"method":"paypal-vault","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"USD","status":"processing","type":"pay","refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"payment_type_data":{"amount":107.51,"currency":"BRL","expiration_date":"2025-06-04","image_url":"https://payment-provider.example/transaction/abc123","number":"3419109107005633044159101318002","type":"CUSTOM"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestRecurringTokenCancellation":{"id":"components/examples/ExampleApmRequestRecurringTokenCancellation","value":{"token":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55"}},"components/examples/ExampleApmResponseRecurringTokenCancellationSuccess":{"id":"components/examples/ExampleApmResponseRecurringTokenCancellationSuccess","value":{"status":"processing"}},"components/examples/ExampleApmResponseRecurringTokenCancellationErrorAuthFailed":{"id":"components/examples/ExampleApmResponseRecurringTokenCancellationErrorAuthFailed","value":{"error":{"code":"1.01","messages":["Authentication failed"]}}},"components/examples/ExampleApmResponseRecurringTokenCancellationErrorTokenNotFound":{"id":"components/examples/ExampleApmResponseRecurringTokenCancellationErrorTokenNotFound","value":{"error":{"code":"2.01","messages":{"general":["recurring token was not found"]}}}},"components/examples/ExampleApmResponseRecurringTokenCancellationErrorUnsupportedMethod":{"id":"components/examples/ExampleApmResponseRecurringTokenCancellationErrorUnsupportedMethod","value":{"error":{"code":"2.01","messages":{"general":["recurring token payment method is bizum, but should be one of the following: alipay, mbway, wechatpay"]}}}},"components/examples/ExampleApmResponseRecurringTokenCancellationErrorAlreadyCancelled":{"id":"components/examples/ExampleApmResponseRecurringTokenCancellationErrorAlreadyCancelled","value":{"error":{"code":"2.01","messages":{"general":["recurring token is already cancelled"]}}}},"components/examples/ExampleApmResponseRecurringTokenCancellationErrorAlreadyProcessing":{"id":"components/examples/ExampleApmResponseRecurringTokenCancellationErrorAlreadyProcessing","value":{"error":{"code":"2.01","messages":{"general":["recurring token cancellation is already processing"]}}}},"components/examples/ExampleApmResponseRecurringTokenCancellationErrorAlreadyConcurrentlyProcessing":{"id":"components/examples/ExampleApmResponseRecurringTokenCancellationErrorAlreadyConcurrentlyProcessing","value":{"error":{"code":"2.01","messages":{"general":["recurring token cancellation is already concurrently processing"]}}}},"components/examples/ExampleApmResponseRecurringTokenCancellationErrorFailed":{"id":"components/examples/ExampleApmResponseRecurringTokenCancellationErrorFailed","value":{"error":{"code":"2.01","messages":{"general":["recurring token cancellation has failed"]}}}},"components/examples/ExampleApmRequestRefund":{"id":"components/examples/ExampleApmRequestRefund","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"refund_reason_code":"0022"}},"components/examples/ExampleApmResponseCheckOrderStatus":{"id":"components/examples/ExampleApmResponseCheckOrderStatus","value":{"order":{"method":"paypal-vault","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"USD","status":"processing","order_description":"Premium package","descriptor":"PAYPAL *MERCH TOPSELL","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0","provider_data":{"billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"payer":{"account_id":"Z5WEEM3YYCXBB","first_name":"John","last_name":"Doe","email":"example@example.com","phone":"+352111222333"},"merchant":{"account_id":"78UQ777KUJAQN"}}},"error":{"code":"5.02","messages":["Invalid Card Token"],"recommended_message_for_user":"Invalid Card Token"},"transactions":[{"method":"paypal-vault","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"USD","status":"processing","type":"pay","refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"payment_type_data":{"amount":107.51,"currency":"BRL","expiration_date":"2025-06-04","image_url":"https://payment-provider.example/transaction/abc123","number":"3419109107005633044159101318002","type":"CUSTOM"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleBillingResponseProductListOneTime":{"id":"components/examples/ExampleBillingResponseProductListOneTime","value":{"data":[{"id":"cb43b415-5522-4373-b026-a365462f9114","name":"Luxury product","type":"one-time","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}],"pagination":{"offset":20,"limit":10,"total_count":150}}},"components/examples/ExampleBillingResponseProductListSubscription":{"id":"components/examples/ExampleBillingResponseProductListSubscription","value":{"data":[{"id":"cb43b415-5522-4373-b026-a365462f9114","name":"Luxury product","type":"recurring","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}],"pagination":{"offset":20,"limit":10,"total_count":150}}},"components/examples/ExampleBillingRequestProductCreateOneTime":{"id":"components/examples/ExampleBillingRequestProductCreateOneTime","value":{"name":"Luxury product","type":"one-time","description":"This product is the best product all over the world","public_description":"That cool product which you have bought","status":"active","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}},"components/examples/ExampleBillingRequestProductCreateSubscription":{"id":"components/examples/ExampleBillingRequestProductCreateSubscription","value":{"name":"Luxury product","type":"recurring","description":"This product is the best product all over the world","public_description":"That cool product which you have bought","status":"active","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}},"components/examples/ExampleBillingResponseProductCreateOneTime":{"id":"components/examples/ExampleBillingResponseProductCreateOneTime","value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"one-time","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}},"components/examples/ExampleBillingResponseProductCreateSubscription":{"id":"components/examples/ExampleBillingResponseProductCreateSubscription","value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"recurring","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}},"components/examples/ExampleBillingResponseProductGetByIdOneTime":{"id":"components/examples/ExampleBillingResponseProductGetByIdOneTime","value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"one-time","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}},"components/examples/ExampleBillingResponseProductGetByIdSubscription":{"id":"components/examples/ExampleBillingResponseProductGetByIdSubscription","value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"recurring","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}},"components/examples/ExampleBillingRequestProductUpdateOneTime":{"id":"components/examples/ExampleBillingRequestProductUpdateOneTime","value":{"name":"Luxury product","description":"This product is the best product all over the world","public_description":"That cool product which you have bought","status":"active","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}},"components/examples/ExampleBillingRequestProductUpdateSubscription":{"id":"components/examples/ExampleBillingRequestProductUpdateSubscription","value":{"name":"Luxury product","description":"This product is the best product all over the world","public_description":"That cool product which you have bought","status":"active","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}},"components/examples/ExampleBillingResponseProductUpdateOneTime":{"id":"components/examples/ExampleBillingResponseProductUpdateOneTime","value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"one-time","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}},"components/examples/ExampleBillingResponseProductUpdateSubscription":{"id":"components/examples/ExampleBillingResponseProductUpdateSubscription","value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"recurring","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}},"components/examples/ExampleBillingResponseProductArchiveOneTime":{"id":"components/examples/ExampleBillingResponseProductArchiveOneTime","value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"one-time","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"archived","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}},"components/examples/ExampleBillingResponseProductArchiveSubscription":{"id":"components/examples/ExampleBillingResponseProductArchiveSubscription","value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"recurring","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"archived","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}},"components/examples/ExampleBillingResponseTaxTransactionalDownload":{"id":"components/examples/ExampleBillingResponseTaxTransactionalDownload","value":{"report_url":"https://reports.solidgate.com/api/v1/tax/transactional/report/TAX_250702_140728_CHECKOUT/download"}},"components/examples/ExampleBillingResponseTaxSummaryDownload":{"id":"components/examples/ExampleBillingResponseTaxSummaryDownload","value":{"report_url":"https://reports.solidgate.com/api/v1/tax/summary/report/TAX_250702_140728_CHECKOUT/download"}},"components/examples/ExampleBillingResponseProductPriceCalculate":{"id":"components/examples/ExampleBillingResponseProductPriceCalculate","value":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","currency":"USD","total_amount":100,"tax":{"tax_amount":20,"taxable_amount":80,"location":"USA","profile_id":"taxp_01JJVD231C879QBHVTVCWJ1K2A","rate_id":"taxr_01JJVD231C879QBHVTVCWJ1K2A","rate":25,"is_included":true},"recurring":{"total_amount":100,"tax":{"tax_amount":20,"taxable_amount":80,"location":"USA","rate":25,"is_included":true}}}},"components/examples/ExampleBillingResponseEntityNotFound":{"id":"components/examples/ExampleBillingResponseEntityNotFound","value":{"error":{"code":"2.01","message":"{entityName} not found"}}},"components/examples/ExampleReportsResponseCardOrders":{"id":"components/examples/ExampleReportsResponseCardOrders","value":{"orders":[{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","product_id":"a12b3c4d-5678-90ab-cdef-1234567890ab","product_name":"Premium package","product_type":"recurring","subscription_id":"b64f6196-5d39-47a8-9bfa-3a39501c6c44","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","processing_amount":10,"processing_currency":"USD","settled_amount":0,"settled_currency":null,"refunded_amount":0,"refunded_currency":null,"status":"processing","refund":null,"payment_type":"recurring","payment_method":"token","type":"recurring","is_secured":true,"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","connector_account_id":"01K7RF79XMK2FNV66Y84ZPMCAE"}]},"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook","platform":"MOB","geo_country":"USA","error_code":"3.02","transactions":[{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","operation":"recurring","status":"processing","authorization_type":"final","original_payment_method":"apple-pay","descriptor":"google.com","refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435"}}],"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}],"metadata":{"next_page_iterator":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9","count":1}}},"components/examples/ExampleReportsResponseApmOrders":{"id":"components/examples/ExampleReportsResponseApmOrders","value":{"orders":[{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","product_id":"a12b3c4d-5678-90ab-cdef-1234567890ab","product_name":"Premium package","product_type":"recurring","subscription_id":"b64f6196-5d39-47a8-9bfa-3a39501c6c44","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","method":"paypal-vault","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","settled_amount":0,"settled_currency":null,"refunded_amount":0,"refunded_currency":null,"status":"processing","refund":null,"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0","geo_country":"USA","error_code":"3.02","transactions":[{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","psp_transaction_id":"txn_5019d00bb70f82cd42f6bc654cbdfcbd63a9","created_at":"2025-12-28 11:45:30","updated_at":"2025-12-29 11:45:30","method":"paypal-vault","amount":100,"currency":"USD","status":"processing","type":"pay"}],"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}],"metadata":{"next_page_iterator":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9","count":1}}},"components/examples/ExampleReportsResponseSubscriptions":{"id":"components/examples/ExampleReportsResponseSubscriptions","value":{"subscriptions":{"<subscription_id_value_#1>":{"id":"64e1c283-17bf-45a7-90ea-2cb938081b2f","status":"cancelled","updated_at":"2025-06-10 15:42:25","started_at":"2025-06-10 15:42:24","expired_at":"2025-09-10 16:42:24","next_charge_at":"2025-11-26 11:43:52","payment_type":"paypal-vault","trial":true,"cancelled_at":"2025-06-26 06:43:58","cancel_code":"8.01","cancel_message":"Card brand is not supported","customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"product":{"id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1},"invoices":{"<invoice_id_value_#1>":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"fail","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"<order_id_value_#1>":{"id":"1672066481283AlexKho","status":"processing","created_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","operation":"pay","amount":100,"payment_details":{"invoice_id":"12344333-3ace-415f-9ae7-730014fceb25","payer_email":"example@example.com"},"retry_attempt":0}}}},"pause":{"from_date":"2026-01-27 11:26:08","to_date":"2026-01-27 11:26:08"}}},"metadata":{"next_page_iterator":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9","count":1}}},"components/examples/ExampleReportsResponseChargebacks":{"id":"components/examples/ExampleReportsResponseChargebacks","value":{"orders":[{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","created_at":"2025-08-18 09:57:42","updated_at":"2025-08-18 09:57:42","amount":100,"currency":"USD","status":"settle_ok","type":"pay","is_secured":false,"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","ip_address":"203.0.113.0","platform":"WEB","geo_country":"USA","chargebacks":[{"id":"892140","created_at":"2025-08-18 09:57:49","updated_at":"2025-08-18 09:57:49","dispute_date":"2025-08-18 09:57:49","settlement_date":"2025-08-18 09:57:49","amount":100,"currency":"USD","type":"1st_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","flows":[{"id":"1159271","date":"2025-08-18 00:00:00","created_at":"2025-08-18 09:57:48","updated_at":"2025-08-18 09:57:49","settlement_date":"2025-08-18 00:00:00","deadline_date":"2025-08-28 00:00:00","amount":100,"dispute_amount":100,"currency":"USD","type":"1st_chb","status":"in_progress","represented_by":"merchant","arn_code":"24871153022084127852235"}]}]}],"metadata":{"next_page_iterator":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9","count":1}}},"components/examples/ExampleReportsResponsePaypalDisputes":{"id":"components/examples/ExampleReportsResponsePaypalDisputes","value":{"disputes":[{"dispute_id":"PP-D-85112454","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","subscription_product_id":"ac43b415-5522-4373-b026-a365462f9657","subscription_service_id":"fb603790-1234-1111-9876-ae4d59d5d378","created_at":"2025-08-23 12:05:28","updated_at":"2025-08-23 12:05:28","seller_response_due_date":"2025-09-14 16:29:12","dispute_amount":100,"dispute_currency":"USD","dispute_life_cycle_stage":"INQUIRY","dispute_channel":"INTERNAL","dispute_create_time":"2025-07-02 23:39:06","dispute_update_time":"2025-07-08 1:40:44","dispute_outcome":"RESOLVED_WITH_PAYOUT","reason":"MERCHANDISE_OR_SERVICE_NOT_RECEIVED","status":"WAITING_FOR_BUYER_RESPONSE","represented_by":"automation","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"}],"metadata":{"next_page_iterator":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9","count":1}}},"components/examples/ExampleReportsResponsePreventionAlertsDownload":{"id":"components/examples/ExampleReportsResponsePreventionAlertsDownload","value":{"report_url":"https://reports.solidgate.com/api/v1/prevention_alerts/report/PREVENT_250702_140728_CHECKOUT/download"}},"components/examples/ExampleReportsResponseFraudAlerts":{"id":"components/examples/ExampleReportsResponseFraudAlerts","value":{"alerts":[{"id":9148812,"order_id":"923bb4e6-4a5f-41ec-81fb-48eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","fraud_amount":50,"fraud_currency":"USD","fraud_amount_usd":100,"fraud_report_date":"2025-03-24 14:22:15","fraud_type":"6","card_scheme":"VISA","reason_code_description":"Fraudulent Use of Account Number"}],"metadata":{"next_page_iterator":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9","count":1}}},"components/examples/ExampleReportsResponseFinancialEntriesDownload":{"id":"components/examples/ExampleReportsResponseFinancialEntriesDownload","value":{"report_url":"https://reports.solidgate.com/api/v1/finance/financial_entries/report/FIN_250702_140728_CHECKOUT/download"}},"components/examples/ExampleReportsResponseRoutingV2ReportDownload":{"id":"components/examples/ExampleReportsResponseRoutingV2ReportDownload","value":{"report_url":"https://reports.solidgate.com/api/v1/routing/events/report/ROUTING_250702_140728_CHECKOUT/download"}},"components/examples/ExampleRequestRisksFraudPreventionListItemsCreate":{"id":"components/examples/ExampleRequestRisksFraudPreventionListItemsCreate","value":{"items":[{"list_type":"pass","payment_field":"card_id","field_value":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","expired_at":"2025-12-21 11:21:30","description":"This is a pass rule","created_by":"email@email.com"},{"list_type":"reject","payment_field":"ip_address","field_value":"123.123.123.123","description":"This is a reject rule"}]}},"components/examples/ExampleResponseRisksFraudPreventionListItemsCreate":{"id":"components/examples/ExampleResponseRisksFraudPreventionListItemsCreate","value":{"items":[{"id":"1234567","list_type":"pass","payment_field":"card_id","field_value":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-08-20 11:21:30","expired_at":"2025-12-21 11:21:30","description":"This is a pass rule","created_by":"email@email.com"},{"id":"1234568","list_type":"reject","payment_field":"ip_address","field_value":"123.123.123.123","created_at":"2025-09-20 11:21:30","expired_at":null,"description":"This is a reject rule"}]}},"components/examples/ExampleResponseErrorFraudPreventionNotEnabled":{"id":"components/examples/ExampleResponseErrorFraudPreventionNotEnabled","value":{"error":{"code":"2.01","messages":["Fraud prevention is not enabled"]}}},"components/examples/ExampleResponseErrorFraudPreventionListItemsDuplicated":{"id":"components/examples/ExampleResponseErrorFraudPreventionListItemsDuplicated","value":{"error":{"code":"2.01","messages":["Some fraud prevention list items are duplicated"]}}},"components/examples/ExampleRequestRisksFraudPreventionListItemList":{"id":"components/examples/ExampleRequestRisksFraudPreventionListItemList","value":{"list_type":"pass","payment_field_value":{"payment_field":"customer_email","field_value":"test@test.com"},"limit":2000,"include_deleted":true,"created_at_from":"2025-08-15 11:00:00","created_at_to":"2025-08-18 11:00:00","next_page_iterator":"1234567"}},"components/examples/ExampleResponseRisksFraudPreventionListItemList":{"id":"components/examples/ExampleResponseRisksFraudPreventionListItemList","value":{"items":[{"id":"1234567","list_type":"pass","payment_field":"customer_email","field_value":"test@test.com","created_at":"2025-08-20 11:21:30","expired_at":"2025-12-21 11:21:30","deleted_at":"2025-08-27 11:21:30","description":"This is a test rule","created_by":"email@email.com"}],"metadata":{"next_page_iterator":"1234567","count":2000}}},"components/examples/ExampleResponseRisksFraudPreventionListItemDelete":{"id":"components/examples/ExampleResponseRisksFraudPreventionListItemDelete","value":{"id":"1234567","list_type":"pass","payment_field":"card_id","field_value":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-08-20 11:21:30","expired_at":"2025-12-21 11:21:30","description":"This is a pass rule","created_by":"email@email.com"}},"components/examples/ExampleResponseErrorFraudPreventionListItemNotFound":{"id":"components/examples/ExampleResponseErrorFraudPreventionListItemNotFound","value":{"error":{"code":"2.01","messages":["Item not found"]}}},"components/examples/ExampleRequestRisksDisputeRepresentmentsCreateCard":{"id":"components/examples/ExampleRequestRisksDisputeRepresentmentsCreateCard","value":{"dispute_type":"card","dispute_id":"123455667","evidence_file_id":"file_01AAABBBCCC123456"}},"components/examples/ExampleRequestRisksDisputeRepresentmentsCreatePayPal":{"id":"components/examples/ExampleRequestRisksDisputeRepresentmentsCreatePayPal","value":{"dispute_type":"paypal","dispute_id":"PP-D-123456789","evidence_file_id":"file_01AAABBBCCC123456"}},"components/examples/ExampleResponseRisksDisputeRepresentmentsCreate":{"id":"components/examples/ExampleResponseRisksDisputeRepresentmentsCreate","value":{"id":"repr_10DDDEEEFFF123456"}},"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsInvalidData":{"id":"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsInvalidData","value":{"error":{"code":"2.01","constraints":{"dispute_id":[{"code":"NotBlank","message":"is required"}]},"message":"Validation error"}}},"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsDisputeNotFound":{"id":"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsDisputeNotFound","value":{"error":{"code":"2.01","message":"Dispute not found"}}},"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileNotFound":{"id":"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileNotFound","value":{"error":{"code":"2.01","message":"File not found"}}},"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileNotReady":{"id":"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileNotReady","value":{"error":{"code":"2.01","message":"File not ready"}}},"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileSizeExceeded":{"id":"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileSizeExceeded","value":{"error":{"code":"2.01","message":"File size exceeded"}}},"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileTypeNotSupported":{"id":"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileTypeNotSupported","value":{"error":{"code":"2.01","message":"File type not supported"}}},"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsAlreadyExists":{"id":"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsAlreadyExists","value":{"error":{"code":"2.01","message":"Representment already exists"}}},"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsNotPossible":{"id":"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsNotPossible","value":{"error":{"code":"2.01","message":"Representment not possible"}}},"components/examples/ExampleRequestRisksDisputeRepresentmentsEnrichCard":{"id":"components/examples/ExampleRequestRisksDisputeRepresentmentsEnrichCard","value":{"dispute_type":"card","dispute_id":"123455667","enrichment":{"proof_of_communication":[{"file_id":"file_01AAABBBCCC123451","annotation":"Email confirming subscription renewal."}],"application_logs":[{"file_id":"file_01AAABBBCCC12342","annotation":"User login history for disputed period."}],"proof_of_delivery":[{"file_id":"file_01AAABBBCCC12343","annotation":"Signed delivery confirmation."}],"invoice":[{"file_id":"file_01AAABBBCCC12344","annotation":"Invoice for order #12345."}],"receipts":[{"file_id":"file_01AAABBBCCC12345","annotation":"Payment receipt dated 2024-01-15."}],"other":[{"file_id":"file_01AAABBBCCC12346","annotation":"Terms of service accepted by customer."}]}}},"components/examples/ExampleRequestRisksDisputeRepresentmentsEnrichPayPal":{"id":"components/examples/ExampleRequestRisksDisputeRepresentmentsEnrichPayPal","value":{"dispute_type":"paypal","dispute_id":"PP-D-123456789","enrichment":{"proof_of_communication":[{"file_id":"file_01AAABBBCCC123451","annotation":"Email confirming subscription renewal."}],"application_logs":[{"file_id":"file_01AAABBBCCC12342","annotation":"User login history for disputed period."}],"proof_of_delivery":[{"file_id":"file_01AAABBBCCC12343","annotation":"Signed delivery confirmation."}],"invoice":[{"file_id":"file_01AAABBBCCC12344","annotation":"Invoice for order #12345."}],"receipts":[{"file_id":"file_01AAABBBCCC12345","annotation":"Payment receipt dated 2024-01-15."}],"other":[{"file_id":"file_01AAABBBCCC12346","annotation":"Terms of service accepted by customer."}]},"submit":false}},"components/examples/ExampleResponseRisksDisputeRepresentmentsEnrich":{"id":"components/examples/ExampleResponseRisksDisputeRepresentmentsEnrich","value":{}},"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsTotalFileSizeExceeded":{"id":"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsTotalFileSizeExceeded","value":{"error":{"code":"2.01","message":"Total files size exceeded"}}},"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsEnrichmentNotPossible":{"id":"components/examples/ExampleResponseErrorRisksDisputeRepresentmentsEnrichmentNotPossible","value":{"error":{"code":"2.01","message":"Enrichment not possible"}}},"components/examples/ExampleResponseSuccessFile":{"id":"components/examples/ExampleResponseSuccessFile","value":{"file_id":"file_01AAABBBCCC123456","upload_url":"https://storage.example.com/file/x?signature=123"}},"components/examples/ExampleResponseErrorFileValidationError":{"id":"components/examples/ExampleResponseErrorFileValidationError","value":{"error":{"code":"2.01","message":"Invalid request","constraints":{"file_size":[{"code":"InvalidSize","message":"file_size must be less than 52428800 bytes"}],"file_type":[{"code":"InvalidExtension","message":"file_type extension is not supported"}]}}}},"components/examples/ExampleWebhooksResponseEndpointList":{"id":"components/examples/ExampleWebhooksResponseEndpointList","value":{"data":[{"id":"5831596c-ba07-4bb5-b35a-cf08a28b4c3f","url":"https://merchant.example/webhook","event_types":["card_gate.order.updated","card_gate.chargeback.received"],"name":"Order status updates","status":"active","created_at":"2025-01-01 12:00:00","updated_at":"2025-01-02 12:00:00"},{"id":"64033036-34ed-486e-bb0b-3b965560036a","url":"https://merchant.example/webhook","event_types":["card_gate.order.updated","card_gate.chargeback.received"],"name":"Order updates","status":"inactive","created_at":"2025-01-01 12:00:00","updated_at":"2025-01-02 12:00:00"}],"pagination":{"offset":2,"limit":2,"total_count":20}}},"components/examples/ExampleWebhooksResponseEndpointInvalidLimit":{"id":"components/examples/ExampleWebhooksResponseEndpointInvalidLimit","value":{"error":{"code":"2.01","message":"Invalid limit value"}}},"components/examples/ExampleWebhooksResponseEndpointLimitOutOfRange":{"id":"components/examples/ExampleWebhooksResponseEndpointLimitOutOfRange","value":{"error":{"code":"2.01","message":"Limit must be between 1 and 100"}}},"components/examples/ExampleWebhooksResponseEndpointInvalidOffset":{"id":"components/examples/ExampleWebhooksResponseEndpointInvalidOffset","value":{"error":{"code":"2.01","message":"Invalid offset value"}}},"components/examples/ExampleWebhooksResponseEndpointNegativeOffset":{"id":"components/examples/ExampleWebhooksResponseEndpointNegativeOffset","value":{"error":{"code":"2.01","message":"Offset cannot be negative"}}},"components/examples/ExampleWebhooksResponseEndpointIDsMaxLen":{"id":"components/examples/ExampleWebhooksResponseEndpointIDsMaxLen","value":{"error":{"code":"2.01","message":"ID list exceeds maximum length of 50 items"}}},"components/examples/ExampleWebhooksResponseEndpointEmptyIDInList":{"id":"components/examples/ExampleWebhooksResponseEndpointEmptyIDInList","value":{"error":{"code":"2.01","message":"Empty ID at position 1"}}},"components/examples/ExampleWebhooksRequestCreate":{"id":"components/examples/ExampleWebhooksRequestCreate","value":{"url":"https://merchant.example/webhook","event_types":["card_gate.order.updated","card_gate.chargeback.received"],"name":"Order status updates"}},"components/examples/ExampleWebhooksRequestCreateWithStatus":{"id":"components/examples/ExampleWebhooksRequestCreateWithStatus","value":{"url":"https://merchant.example/webhook","event_types":["card_gate.order.updated","card_gate.chargeback.received"],"name":"Order status updates","status":"active"}},"components/examples/ExampleWebhooksResponse":{"id":"components/examples/ExampleWebhooksResponse","value":{"id":"5831596c-ba07-4bb5-b35a-cf08a28b4c3f","url":"https://merchant.example/webhook","event_types":["card_gate.order.updated","card_gate.chargeback.received"],"name":"Order status updates","status":"active","created_at":"2025-01-01 12:00:00","updated_at":"2025-01-02 12:00:00"}},"components/examples/ExampleWebhooksResponseInvalidJSON":{"id":"components/examples/ExampleWebhooksResponseInvalidJSON","value":{"error":{"code":"2.01","message":"Invalid json"}}},"components/examples/ExampleWebhooksResponseInvalidURL":{"id":"components/examples/ExampleWebhooksResponseInvalidURL","value":{"error":{"code":"2.01","constraints":{"url":[{"code":"URL","message":"must be a valid value"}]},"message":"Validation error"}}},"components/examples/ExampleWebhooksResponseInvalidEventType":{"id":"components/examples/ExampleWebhooksResponseInvalidEventType","value":{"error":{"code":"2.01","constraints":{"event_types.0":[{"code":"Enum","message":"must be a valid value"}]},"message":"Validation error"}}},"components/examples/ExampleWebhooksResponseInvalidStatus":{"id":"components/examples/ExampleWebhooksResponseInvalidStatus","value":{"error":{"code":"2.01","constraints":{"status":[{"code":"Enum","message":"must be a valid value"}]},"message":"Validation error"}}},"components/examples/ExampleWebhooksResponseEndpointNameLen":{"id":"components/examples/ExampleWebhooksResponseEndpointNameLen","value":{"error":{"code":"2.01","constraints":{"name":[{"code":"Length","message":"the length must be no more than 255"}]},"message":"Validation error"}}},"components/examples/ExampleWebhooksResponseEndpointURLLen":{"id":"components/examples/ExampleWebhooksResponseEndpointURLLen","value":{"error":{"code":"2.01","constraints":{"url":[{"code":"Length","message":"the length must be no more than 512"}]},"message":"Validation error"}}},"components/examples/ExampleWebhooksResponseEndpointAlreadyExist":{"id":"components/examples/ExampleWebhooksResponseEndpointAlreadyExist","value":{"error":{"code":"2.01","message":"Endpoint with the same URL for current channel already exists"}}},"components/examples/ExampleWebhooksResponseEndpointLimitReached":{"id":"components/examples/ExampleWebhooksResponseEndpointLimitReached","value":{"error":{"code":"2.01","message":"Maximum endpoints per channel limit reached"}}},"components/examples/ExampleWebhooksRequestUpdateAll":{"id":"components/examples/ExampleWebhooksRequestUpdateAll","value":{"event_types":["card_gate.order.updated","card.network_token.updated"],"name":"Order status updates","url":"https://merchant.example/webhook-updated","status":"active"}},"components/examples/ExampleWebhooksRequestUpdateEventTypes":{"id":"components/examples/ExampleWebhooksRequestUpdateEventTypes","value":{"event_types":["card_gate.order.updated","card.network_token.updated"]}},"components/examples/ExampleWebhooksRequestUpdateStatus":{"id":"components/examples/ExampleWebhooksRequestUpdateStatus","value":{"url":"https://merchant.example/webhook","event_types":["card_gate.order.updated","subscription.updated"],"status":"active"}},"components/examples/ExampleWebhooksRequestUpdateName":{"id":"components/examples/ExampleWebhooksRequestUpdateName","value":{"name":"Order status updates"}},"components/examples/ExampleWebhooksRequestUpdateURL":{"id":"components/examples/ExampleWebhooksRequestUpdateURL","value":{"url":"https://merchant.example/webhook-updated"}},"components/examples/ExampleWebhooksResponseEndpointNotFound":{"id":"components/examples/ExampleWebhooksResponseEndpointNotFound","value":{"error":{"code":"2.01","message":"Endpoint not found"}}},"components/examples/ExampleCardsRequestWebhookOrderStatus":{"id":"components/examples/ExampleCardsRequestWebhookOrderStatus","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"authorized_amount":100,"status":"auth_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"8.8.8.8","traffic_source":"facebook"},"error":{"code":"3.08","messages":["Do not honor"],"recommended_message_for_user":"Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","authorization_type":"final","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"}},"error":{"code":"3.08","messages":["Do not honor"],"recommended_message_for_user":"Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","authorization_type":"final","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"}},"error":{"code":"3.08","messages":["Do not honor"],"recommended_message_for_user":"Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"05","flow":"frictionless","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"review"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"id":147712,"dispute_date":"2026-07-11 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"verify_url":"https://merchant.example/verify","redirect_url":"https://merchant.example/redirect","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleCardsRequestWebhookNetworkTokenCreated":{"id":"components/examples/ExampleCardsRequestWebhookNetworkTokenCreated","value":{"card_id":"123e4567-e89b-12d3-a456-426614174000","tokenization_type":"vts","status":"INACTIVE","created_at":"2025-08-17 11:45:30","updated_at":"2025-08-17 11:45:30"}},"components/examples/ExampleCardsRequestWebhookNetworkTokenUpdated":{"id":"components/examples/ExampleCardsRequestWebhookNetworkTokenUpdated","value":{"card_id":"123e4567-e89b-12d3-a456-426614174000","tokenization_type":"vts","status":"INACTIVE","created_at":"2025-08-17 11:45:30","updated_at":"2025-08-17 11:45:30"}},"components/examples/ExampleCardsRequestWebhookChargeback":{"id":"components/examples/ExampleCardsRequestWebhookChargeback","value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":100,"currency":"USD","status":"settle_ok"},"chargeback":{"id":147712,"dispute_date":"2026-07-11 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"1st_chb","status":"in_progress","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","available_actions":["enrich_evidence","provide_evidence"]},"chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"1st_chb","status":"in_progress","represented_by":"automation","arn_code":"24871153022084127852235"}]}},"components/examples/ExampleCardsRequestWebhookPreventAlert":{"id":"components/examples/ExampleCardsRequestWebhookPreventAlert","value":{"order":{"id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2026-07-15 11:45:30","amount":100,"currency":"USD","status":"approved"},"alert":{"id":"83b19018-cbc4-4df0-899a-dda84fd2705e","amount":200,"currency":"EUR","provider_name":"ethoca","alert_date":"2026-07-17 11:01:03","created_at":"2026-07-17 11:03:30","updated_at":"2026-07-17 11:03:31","alert_type":"init-refund","outcome":"reversed"}}},"components/examples/ExampleCardsRequestWebhookFraudAlert":{"id":"components/examples/ExampleCardsRequestWebhookFraudAlert","value":{"id":9147712,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-03-24 14:22:19","updated_at":"2025-03-24 14:22:19","fraud_amount":2575,"fraud_currency":"USD","fraud_amount_usd":12367,"fraud_type":"6","fraud_report_day":"2025-03-24 14:22:18","card_scheme":"VISA","reason_code_description":"Fraudulent use of account number"}},"components/examples/ExampleBillingWebhookTaxCalculated":{"id":"components/examples/ExampleBillingWebhookTaxCalculated","value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"1538344f-9e1a-4ad0-9a1e-7e6e4669775a","total_amount":1000,"currency":"USD","action":"sale","payment_category":"card-payment","transaction_date":"2025-12-06 15:18:40","tax_included":true,"tax":{"tax_amount":91,"taxable_amount":909,"rate":10,"currency":"USD","location":{"country":"USA","state":"MD"},"legal_entity":"Tech Solutions"}}},"components/examples/ExampleApmRequestWebhookOrderStatus":{"id":"components/examples/ExampleApmRequestWebhookOrderStatus","value":{"order":{"method":"paypal-vault","order_id":"dce52ec4-2ee3-45f8-8333-cfbb7ac2ee49","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"currency":"USD","order_description":"Premium package","descriptor":"PAYPAL *MERCH TOPSELL","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","status":"processing","ip_address":"203.0.113.0","provider_data":{"billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"payer":{"account_id":"Z5WEEM3YYCXBB","first_name":"John","last_name":"Doe","email":"example@example.com","phone":"+352111222333"},"merchant":{"account_id":"78UQ777KUJAQN"}}},"error":{"code":"5.02","messages":["Invalid Card Token"],"recommended_message_for_user":"Invalid Card Token"},"transactions":[{"method":"paypal-vault","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"USD","status":"processing","type":"pay","refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022"}],"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}},"components/examples/ExampleApmRequestWebhookPaypalDispute":{"id":"components/examples/ExampleApmRequestWebhookPaypalDispute","value":{"dispute_id":"PP-D-85112454","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","subscription_product_id":"ac43b415-5522-4373-b026-a365462f9657","subscription_service_id":"fb603790-1234-1111-9876-ae4d59d5d378","created_at":"2025-08-23 12:05:28","updated_at":"2025-08-23 12:05:28","seller_response_due_date":"2025-09-14 16:29:12","dispute_amount":100,"dispute_currency":"USD","dispute_life_cycle_stage":"CHARGEBACK","dispute_channel":"INTERNAL","dispute_create_time":"2025-07-02 23:39:06","dispute_update_time":"2025-07-08 1:40:44","dispute_outcome":"RESOLVED_WITH_PAYOUT","reason":"MERCHANDISE_OR_SERVICE_NOT_RECEIVED","status":"WAITING_FOR_SELLER_RESPONSE","represented_by":"merchant","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","available_actions":["enrich_evidence","provide_evidence"]}},"components/examples/ExampleApmRequestWebhookPreventAlert":{"id":"components/examples/ExampleApmRequestWebhookPreventAlert","value":{"order":{"id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","amount":100,"currency":"USD","status":"approved"},"alert":{"id":"83b19018-cbc4-4df0-899a-dda84fd2705e","amount":200,"currency":"EUR","provider_name":"ethoca","alert_date":"2025-12-29 11:01:03","created_at":"2025-12-29 11:03:30","updated_at":"2025-12-29 11:03:31","alert_type":"inquiry","outcome":"reversed"}}},"components/examples/ExampleApmRequestWebhookRevokedRecurringToken":{"id":"components/examples/ExampleApmRequestWebhookRevokedRecurringToken","value":{"token":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","initial_order_id":"22738n","cancelled_at":"2024-12-21 11:21:30"}},"components/examples/ExampleBillingWebhookExtendedCreate":{"id":"components/examples/ExampleBillingWebhookExtendedCreate","value":{"callback_type":"create","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"pending","updated_at":"2025-09-08 12:37:25","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"processing","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"processing","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedExpire":{"id":"components/examples/ExampleBillingWebhookExtendedExpire","value":{"callback_type":"expire","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"expired","updated_at":"2025-09-08 12:37:25","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"fail","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"auth_failed","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedPaymentAttempt":{"id":"components/examples/ExampleBillingWebhookExtendedPaymentAttempt","value":{"callback_type":"payment_attempt","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"pending","updated_at":"2025-09-28 11:45:25","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:10","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-09-27 11:45:30","billing_period_ended_at":"2025-09-28 11:45:40","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"auth_ok","created_at":"2025-09-27 11:45:25","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:25","amount":100,"discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedActive":{"id":"components/examples/ExampleBillingWebhookExtendedActive","value":{"callback_type":"active","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"approved","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedRenew":{"id":"components/examples/ExampleBillingWebhookExtendedRenew","value":{"callback_type":"renew","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"auth_ok","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedSwitchProduct":{"id":"components/examples/ExampleBillingWebhookExtendedSwitchProduct","value":{"callback_type":"switch_product","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-10-01 15:30:00","expired_at":"2025-10-08 12:37:24","next_charge_at":"2025-11-08 12:37:24","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"b62cba1d-4e8f-42f9-a9d1-cef09831f7ae","name":"Premium Audiobook Collection","amount":150,"currency":"USD","trial":false},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-10-01 15:30:00","updated_at":"2025-10-01 15:31:00","amount":150,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-10-08 12:37:24","billing_period_ended_at":"2025-11-08 12:37:24","subscription_term_number":2,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-10-01 15:30:00","updated_at":"2025-10-01 15:30:00","processed_at":"2025-10-01 15:31:00","amount":150,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-10-02 15:30:00","updated_at":"2025-10-02 15:30:00","processed_at":"2025-10-02 15:31:00","amount":150,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedUpdateOrder":{"id":"components/examples/ExampleBillingWebhookExtendedUpdateOrder","value":{"callback_type":"order_update","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-08-26 11:43:52","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"auth_ok","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedPause":{"id":"components/examples/ExampleBillingWebhookExtendedPause","value":{"callback_type":"pause","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"paused","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-28 07:48:15","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false,"pause":{"from_date":"2025-09-11 11:26:08","to_date":"2025-09-27 11:26:08"}},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedCreatePauseSchedule":{"id":"components/examples/ExampleBillingWebhookExtendedCreatePauseSchedule","value":{"callback_type":"pause_schedule.create","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-24 07:48:15","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false,"pause":{"from_date":"2025-09-11 11:26:08","to_date":"2025-09-27 11:26:08"}},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"auth_ok","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedUpdatePauseSchedule":{"id":"components/examples/ExampleBillingWebhookExtendedUpdatePauseSchedule","value":{"callback_type":"pause_schedule.update","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-28 11:48:15","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":true,"pause":{"from_date":"2025-09-11 11:26:08","to_date":"2025-09-27 11:26:08"}},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedDeletePauseSchedule":{"id":"components/examples/ExampleBillingWebhookExtendedDeletePauseSchedule","value":{"callback_type":"pause_schedule.delete","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"auth_ok","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedResume":{"id":"components/examples/ExampleBillingWebhookExtendedResume","value":{"callback_type":"resume","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"auth_ok","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedRecurring":{"id":"components/examples/ExampleBillingWebhookExtendedRecurring","value":{"callback_type":"recurring","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"approved","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedRestore":{"id":"components/examples/ExampleBillingWebhookExtendedRestore","value":{"callback_type":"restore","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"auth_ok","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedCancel":{"id":"components/examples/ExampleBillingWebhookExtendedCancel","value":{"callback_type":"cancel","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"cancelled","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false,"cancelled_at":"2025-09-12 19:37:24","cancellation_requested_at":"2025-09-11 19:37:24","cancel_code":"8.09","cancel_message":"Cancellation after redemption period"},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"fail","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedScheduleCancellation":{"id":"components/examples/ExampleBillingWebhookExtendedScheduleCancellation","value":{"callback_type":"scheduled_for_cancellation","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","payment_type":"upi","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false,"cancelled_at":"2025-09-12 19:37:24","cancellation_requested_at":"2025-09-11 19:37:24","cancel_code":"8.09","cancel_message":"Cancellation after redemption period"},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"auth_ok","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedRedemption":{"id":"components/examples/ExampleBillingWebhookExtendedRedemption","value":{"callback_type":"redemption","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"redemption","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-10-08 11:43:52","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"retry","created_at":"2025-09-08 11:45:25","updated_at":"2025-09-08 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-08 11:45:25","updated_at":"2025-09-08 11:45:25","processed_at":"2025-09-08 11:45:30","amount":1000,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedRetry":{"id":"components/examples/ExampleBillingWebhookExtendedRetry","value":{"callback_type":"retry","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"redemption","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"retry","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-27 07:55:41","amount":1000,"failed_reason":"3.02","retry_attempt":1},"1772066481453AlexKhy":{"id":"1772066481453AlexKhy","status":"processing","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","amount":1000,"retry_attempt":2}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookExtendedScheduleRetry":{"id":"components/examples/ExampleBillingWebhookExtendedScheduleRetry","value":{"callback_type":"scheduled_for_retry","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"redemption","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"retry","created_at":"2025-09-08 12:45:30","updated_at":"2025-09-08 12:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-08 12:45:30","updated_at":"2025-09-08 12:45:30","processed_at":"2025-09-08 12:45:41","amount":1000,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1772066481453AlexKhy":{"id":"1772066481453AlexKhy","status":"declined","created_at":"2025-09-10 11:45:30","updated_at":"2025-09-10 11:45:30","processed_at":"2025-09-10 12:45:41","amount":1000,"failed_reason":"3.02","retry_attempt":2,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookInit":{"id":"components/examples/ExampleBillingWebhookInit","value":{"callback_type":"init","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-11-26 11:43:52","payment_type":"paypal-vault","trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"approved","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookRenew":{"id":"components/examples/ExampleBillingWebhookRenew","value":{"callback_type":"renew","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-12-12 12:37:24","payment_type":"card","trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"auth_ok","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookUpdate":{"id":"components/examples/ExampleBillingWebhookUpdate","value":{"callback_type":"update","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"cancelled","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-11-26 11:43:52","payment_type":"paypal-vault","trial":false,"cancelled_at":"2025-12-12 12:37:20","cancellation_requested_at":"2025-12-12 12:37:20","cancel_code":"8.09","cancel_message":"Cancellation after redemption period"},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"approved","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookCancel":{"id":"components/examples/ExampleBillingWebhookCancel","value":{"callback_type":"cancel","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"cancelled","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","payment_type":"card","trial":false,"cancelled_at":"2025-12-12 19:37:24","cancellation_requested_at":"2025-12-11 19:37:24","cancel_code":"8.09","cancel_message":"Cancellation after redemption period"},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"fail","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookPause":{"id":"components/examples/ExampleBillingWebhookPause","value":{"callback_type":"pause","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"paused","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-12-28 07:48:15","payment_type":"paypal-vault","trial":false,"pause":{"from_date":"2025-12-11 11:26:08","to_date":"2025-12-27 11:26:08"}},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-12-28 11:50:30","updated_at":"2025-12-28 11:50:30","processed_at":"2025-12-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookResume":{"id":"components/examples/ExampleBillingWebhookResume","value":{"callback_type":"resume","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-12-12 12:37:24","payment_type":"card","trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-12-28 11:50:30","updated_at":"2025-12-28 11:50:30","processed_at":"2025-12-28 11:50:35","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookCreatePauseSchedule":{"id":"components/examples/ExampleBillingWebhookCreatePauseSchedule","value":{"callback_type":"pause_schedule.create","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","payment_type":"paypal-vault","trial":false,"pause":{"from_date":"2025-12-11 11:26:08","to_date":"2025-12-27 11:26:08"}},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-12-28 11:50:30","updated_at":"2025-12-28 11:50:30","processed_at":"2025-12-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookUpdatePauseSchedule":{"id":"components/examples/ExampleBillingWebhookUpdatePauseSchedule","value":{"callback_type":"pause_schedule.update","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"paused","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-12-28 11:48:15","payment_type":"paypal-vault","trial":false,"pause":{"from_date":"2025-12-11 11:26:08","to_date":"2025-12-27 11:26:08"}},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-12-28 11:50:30","updated_at":"2025-12-28 11:50:30","processed_at":"2025-12-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"components/examples/ExampleBillingWebhookDeletePauseSchedule":{"id":"components/examples/ExampleBillingWebhookDeletePauseSchedule","value":{"callback_type":"pause_schedule.delete","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-12-12 12:37:24","payment_type":"paypal-vault","trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-12-28 11:50:30","updated_at":"2025-12-28 11:50:30","processed_at":"2025-12-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}}},"paths/~1charge/post/requestBody/content/application~1json/examples/PAN Payment":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"card_data_type":"pan","settle_interval":0,"authorization_type":"final","payment_type":"1-click","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"05","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12120001111","card_number":"4067429974719265","card_holder":"John Snow","card_exp_month":"12","card_exp_year":2025,"card_cvv":"123","card_pin":"4492","dynamic_descriptor":{"suffix":"PRODUCTX"},"industry_data":{"type":"airline","airline":[{"airline_code":"001","airline_designator_code":"DL","airline_name":"Delta Airlines","boarding_fee":"500","computerized_reservation_system":"AMAD","customer_reference_number":"A123456789","document_type":"01","flight_date":"2025-09-01 14:30","agency_plan_name":"1B","travel_agency_name":"Skyline Travel","travel_agency_code":"87654321","agency_invoice_number":"INV123","ticket":{"number":"5661234567890","issue_date":"250819","restricted":false,"issue_address":{"line1":"123 Main St","city":"Atlanta","country":"USA","postal":"30301"}},"passenger":{"first_name":"John","last_name":"Doe","date_of_birth":"1985-03-21","phone_number":"+14051234567","traveller_type":"ADT","code":"123"},"flight_legs":[{"flight_number":"DL101","carrier_code":"DL","class_of_travel":"Y","departure_date":"2025-09-01 14:30","departure_airport":"ATL","departure_tax":"100","arrival_airport":"LAX","fare_base_code":"Y123","stop_over_code":"X"}]},{"airline_code":"002","airline_designator_code":"AA","airline_name":"American Airlines","boarding_fee":"500","computerized_reservation_system":"AMAD","customer_reference_number":"B987654321","document_type":"01","flight_date":"2025-10-01 16:00","agency_plan_name":"2A","travel_agency_name":"Global Travel Co","travel_agency_code":"98765432","agency_invoice_number":"INV987","ticket":{"number":"5670987654321","issue_date":"250925","restricted":true,"issue_address":{"line1":"456 Elm St","city":"Dallas","country":"USA","postal":"75201"}},"passenger":{"first_name":"Jane","last_name":"Smith","date_of_birth":"1990-11-10","phone_number":"+14051234568","traveller_type":"ADT","code":"124"},"flight_legs":[{"flight_number":"AA102","carrier_code":"AA","class_of_travel":"Y","departure_date":"2025-10-01 16:00","departure_airport":"DFW","departure_tax":"150","arrival_airport":"ORD","fare_base_code":"Y456","stop_over_code":"X"}]}]},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"PAN Payment","summary":"PAN Payment","id":"paths/~1charge/post/requestBody/content/application~1json/examples/PAN Payment"},"paths/~1charge/post/requestBody/content/application~1json/examples/DPAN Payment":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"card_data_type":"dpan","dpan_source":"apple-pay","eci":"05","cryptogram":"YwAAABkAg0+NbusAMjqEAoABFA=","settle_interval":0,"authorization_type":"final","payment_type":"1-click","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"01","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12120001111","card_number":"4067429974719265","card_holder":"John Snow","card_exp_month":"12","card_exp_year":2025,"card_cvv":"123","card_pin":"4492","dynamic_descriptor":{"suffix":"PRODUCTX"},"industry_data":{"type":"airline","airline":[{"airline_code":"001","airline_designator_code":"DL","airline_name":"Delta Airlines","boarding_fee":"500","computerized_reservation_system":"AMAD","customer_reference_number":"A123456789","document_type":"01","flight_date":"2025-09-01 14:30","agency_plan_name":"1B","travel_agency_name":"Skyline Travel","travel_agency_code":"87654321","agency_invoice_number":"INV123","ticket":{"number":"5661234567890","issue_date":"250819","restricted":false,"issue_address":{"line1":"123 Main St","city":"Atlanta","country":"USA","postal":"30301"}},"passenger":{"first_name":"John","last_name":"Doe","date_of_birth":"1985-03-21","phone_number":"+14051234567","traveller_type":"ADT","code":"123"},"flight_legs":[{"flight_number":"DL101","carrier_code":"DL","class_of_travel":"Y","departure_date":"2025-09-01 14:30","departure_airport":"ATL","departure_tax":"100","arrival_airport":"LAX","fare_base_code":"Y123","stop_over_code":"X"}]},{"airline_code":"002","airline_designator_code":"AA","airline_name":"American Airlines","boarding_fee":"500","computerized_reservation_system":"AMAD","customer_reference_number":"B987654321","document_type":"01","flight_date":"2025-10-01 16:00","agency_plan_name":"2A","travel_agency_name":"Global Travel Co","travel_agency_code":"98765432","agency_invoice_number":"INV987","ticket":{"number":"5670987654321","issue_date":"250925","restricted":true,"issue_address":{"line1":"456 Elm St","city":"Dallas","country":"USA","postal":"75201"}},"passenger":{"first_name":"Jane","last_name":"Smith","date_of_birth":"1990-11-10","phone_number":"+14051234568","traveller_type":"ADT","code":"124"},"flight_legs":[{"flight_number":"AA102","carrier_code":"AA","class_of_travel":"Y","departure_date":"2025-10-01 16:00","departure_airport":"DFW","departure_tax":"150","arrival_airport":"ORD","fare_base_code":"Y456","stop_over_code":"X"}]}]},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"DPAN Payment","summary":"DPAN Payment","id":"paths/~1charge/post/requestBody/content/application~1json/examples/DPAN Payment"},"paths/~1charge/post/requestBody/content/application~1json/examples/Product-based payment":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"83b19018-cbc4-45f0-899a-dda84fd2705e","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","payment_type":"1-click","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"07","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_number":"4067429974719265","card_holder":"John Snow","card_exp_month":"12","card_exp_year":2025,"card_cvv":"123","card_pin":"4492","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Product-based payment","summary":"Product-based payment","id":"paths/~1charge/post/requestBody/content/application~1json/examples/Product-based payment"},"paths/~1charge/post/requestBody/content/application~1json/examples/Subscription payment":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"83b19018-cbc4-45f0-899a-dda84fd2705e","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","payment_type":"1-click","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","retry_attempt":3,"force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"07","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_number":"4067429974719265","card_holder":"John Snow","card_exp_month":"12","card_exp_year":2025,"card_cvv":"123","card_pin":"4492","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1charge/post/requestBody/content/application~1json/examples/Subscription payment"},"paths/~1charge/post/responses/200/content/application~1json/examples/Success":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"settle_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"06","flow":"challenge","exception":"transaction_risk_assessment"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"verify_url":"https://merchant.example/verify","redirect_url":"https://merchant.example/redirect","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Success","summary":"Success","id":"paths/~1charge/post/responses/200/content/application~1json/examples/Success"},"paths/~1charge/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1charge/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1charge/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1charge/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1charge/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1charge/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1charge/post/responses/200/content/application~1json/examples/Error X.XX":{"value":{"error":{"code":"3.02","messages":["Insufficient funds"],"recommended_message_for_user":"The card balance has insufficient funds."}},"key":"Error X.XX","summary":"Error X.XX","id":"paths/~1charge/post/responses/200/content/application~1json/examples/Error X.XX"},"paths/~1google-pay/post/requestBody/content/application~1json/examples/Payment":{"value":{"is_decrypted":false,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","force3ds":false,"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_holder":"John Snow","dynamic_descriptor":{"suffix":"PRODUCTX"},"industry_data":{"type":"car_rental","car_rental":{"agreement_number":"BKID12345","renter_name":"John","pick_up_date":"2026-03-01T11:00:00Z","drop_off_date":"2026-03-05T16:30:00Z","refundability":"partially_refundable","rate":1000,"rate_indicator":"D","days_rented":"10","customer_service_toll_free_number":"8001010123","rental_class_id":"0001","tax_exempt_indicator":"Y","fuel_charges":2000,"insurance_charges":2300,"no_show_indicator":"N","one_way_drop_off_charges":50000,"return_location_id":"AB1234","pick_up_location":{"street_line_1":"1 Example Street","state":"CA","city":"San Francisco","country":"USA","postal":"SW1A1AA"},"drop_off_location":{"street_line_1":"1 Example Street","state":"CA","city":"San Francisco","country":"USA","postal":"SW1A1AA"},"distance_limit":{"limit":500,"unit":"miles","additional_distance_cost":{"amount":150,"currency":"USD"}}}},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","signature":"MEQCIGJGG....0ZpM4YzvUA==","signedMessage":"{\"encryptedMessage\":\"J......t1+Eu003d\"}","protocolVersion":"ECv1","network":"VISA","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Payment","summary":"Payment","id":"paths/~1google-pay/post/requestBody/content/application~1json/examples/Payment"},"paths/~1google-pay/post/requestBody/content/application~1json/examples/Product-based payment":{"value":{"is_decrypted":false,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"83b19018-cbc4-45f0-899a-dda84fd2705e","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","force3ds":false,"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_holder":"John Snow","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","signature":"MEQCIGJGG....0ZpM4YzvUA==","signedMessage":"{\"\"\"\"encryptedMessage\"\"\"\":\"\"J......t1+Eu003d\"\"}","protocolVersion":"ECv1","network":"VISA","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Product-based payment","summary":"Product-based payment","id":"paths/~1google-pay/post/requestBody/content/application~1json/examples/Product-based payment"},"paths/~1google-pay/post/requestBody/content/application~1json/examples/Subscription payment":{"value":{"is_decrypted":false,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"83b19018-cbc4-45f0-899a-dda84fd2705e","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","retry_attempt":3,"force3ds":false,"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_holder":"John Snow","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","signature":"MEQCIGJGG....0ZpM4YzvUA==","signedMessage":"{\"\"\"\"encryptedMessage\"\"\"\":\"\"J......t1+Eu003d\"\"}","protocolVersion":"ECv1","network":"VISA","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1google-pay/post/requestBody/content/application~1json/examples/Subscription payment"},"paths/~1google-pay/post/responses/200/content/application~1json/examples/Success":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"processing","auth_code":"2w9m8","payment_type":"1-click","payment_method":"google-pay","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"05","flow":"frictionless","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"verify_url":"https://merchant.example/verify","redirect_url":"https://merchant.example/redirect","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Success","summary":"Success","id":"paths/~1google-pay/post/responses/200/content/application~1json/examples/Success"},"paths/~1google-pay/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1google-pay/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1google-pay/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1google-pay/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1google-pay/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1google-pay/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1google-pay/post/responses/200/content/application~1json/examples/Error X.XX":{"value":{"error":{"code":"3.02","messages":["Insufficient funds"],"recommended_message_for_user":"The card balance has insufficient funds."}},"key":"Error X.XX","summary":"Error X.XX","id":"paths/~1google-pay/post/responses/200/content/application~1json/examples/Error X.XX"},"paths/~1apple-pay/post/requestBody/content/application~1json/examples/Payment":{"value":{"is_decrypted":false,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12120001111","dynamic_descriptor":{"suffix":"PRODUCTX"},"industry_data":{"type":"car_rental","car_rental":{"agreement_number":"BKID12345","renter_name":"John","pick_up_date":"2026-03-01T11:00:00Z","drop_off_date":"2026-03-05T16:30:00Z","refundability":"partially_refundable","rate":1000,"rate_indicator":"D","days_rented":"10","customer_service_toll_free_number":"8001010123","rental_class_id":"0001","tax_exempt_indicator":"Y","fuel_charges":2000,"insurance_charges":2300,"no_show_indicator":"N","one_way_drop_off_charges":50000,"return_location_id":"AB1234","pick_up_location":{"street_line_1":"1 Example Street","state":"CA","city":"San Francisco","country":"USA","postal":"SW1A1AA"},"drop_off_location":{"street_line_1":"1 Example Street","state":"CA","city":"San Francisco","country":"USA","postal":"SW1A1AA"},"distance_limit":{"limit":500,"unit":"miles","additional_distance_cost":{"amount":150,"currency":"USD"}}}},"ip_address":"203.0.113.0","traffic_source":"facebook","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","zip_code":"90210","country":"USA","state":"WA","city":"Baltimore","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","address":"123 Main St","zip":"91191"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","data":"qIEHeSmLKw8C5...ZIuf2oPeLhQ1DCaQj","signature":"1UdDwEB/wQEAwIHgDAPBgkqh...92ICIAR2","version":"EC_v1","network":"VISA","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"header":{"transactionId":"7126df4ff8ac61dc60278b5cd549cc98d16b8f41","applicationData":null,"ephemeralPublicKey":"MFkwEwY......+Dh2JDCwaKeLKXQ0cUM9ya/1wnrtMHXN4A==","publicKeyHash":"mQaQhyhrXX3ZDSQv...ByX0iii0MVHthSQiXQ=","wrappedKey":null},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Payment","summary":"Payment","id":"paths/~1apple-pay/post/requestBody/content/application~1json/examples/Payment"},"paths/~1apple-pay/post/requestBody/content/application~1json/examples/Product-based payment":{"value":{"is_decrypted":false,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","ip_address":"203.0.113.0","traffic_source":"facebook","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","data":"qIEHeSmLKw3C5...ZIuf2oPeLhQ1DCaQj","signature":"1UdDwEB/wQEAwIHgDAPBgkqh...92ICIAR2","version":"EC_v1","network":"VISA","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"dynamic_descriptor":{"suffix":"PRODUCTX"},"header":{"transactionId":"7126df4ff8ac61dc60278b5cd549cc98d16b8f41","applicationData":null,"ephemeralPublicKey":"MFkwEwY......+Dh2JDCwaKeLKXQ0cUM9ya/1wnrtMHXN4A==","publicKeyHash":"mQaQhyhrXX3ZDSQv...ByX0iii0MVHthSQiXQ=","wrappedKey":null},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Product-based payment","summary":"Product-based payment","id":"paths/~1apple-pay/post/requestBody/content/application~1json/examples/Product-based payment"},"paths/~1apple-pay/post/requestBody/content/application~1json/examples/Subscription payment":{"value":{"is_decrypted":false,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","retry_attempt":3,"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","ip_address":"203.0.113.0","traffic_source":"facebook","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","data":"qIEHeSmLKw3C5...ZIuf2oPeLhQ1DCaQj","signature":"1UdDwEB/wQEAwIHgDAPBgkqh...92ICIAR2","version":"EC_v1","network":"VISA","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"dynamic_descriptor":{"suffix":"PRODUCTX"},"header":{"transactionId":"7126df4ff8ac61dc60278b5cd549cc98d16b8f41","applicationData":null,"ephemeralPublicKey":"MFkwEwY......+Dh2JDCwaKeLKXQ0cUM9ya/1wnrtMHXN4A==","publicKeyHash":"mQaQhyhrXX3ZDSQv...ByX0iii0MVHthSQiXQ=","wrappedKey":null},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1apple-pay/post/requestBody/content/application~1json/examples/Subscription payment"},"paths/~1apple-pay/post/responses/200/content/application~1json/examples/Success":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"settle_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"apple-pay","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"05","flow":"frictionless","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Success","summary":"Success","id":"paths/~1apple-pay/post/responses/200/content/application~1json/examples/Success"},"paths/~1apple-pay/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1apple-pay/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error X.XX":{"value":{"error":{"code":"3.02","messages":["Insufficient funds"],"recommended_message_for_user":"The card balance has insufficient funds."}},"key":"Error X.XX","summary":"Error X.XX","id":"paths/~1apple-pay/post/responses/200/content/application~1json/examples/Error X.XX"},"paths/~1increment/post/requestBody/content/application~1json/examples/Payment incremental auth":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":500},"key":"Payment incremental auth","summary":"Payment incremental auth","id":"paths/~1increment/post/requestBody/content/application~1json/examples/Payment incremental auth"},"paths/~1increment/post/responses/200/content/application~1json/examples/Success":{"value":{"transaction":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","amount":500,"currency":"EUR","status":"processing"}},"key":"Success","summary":"Success","id":"paths/~1increment/post/responses/200/content/application~1json/examples/Success"},"paths/~1increment/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1increment/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.04 Card brand is not supported":{"value":{"error":{"code":"2.04","messages":["Card brand is not supported"]}},"key":"Error 2.04 Card brand is not supported","summary":"Error 2.04 Card brand is not supported","id":"paths/~1increment/post/responses/200/content/application~1json/examples/Error 2.04 Card brand is not supported"},"paths/~1increment/post/responses/200/content/application~1json/examples/Error X.XX":{"value":{"error":{"code":"3.02","messages":["Insufficient funds"],"recommended_message_for_user":"The card balance has insufficient funds."}},"key":"Error X.XX","summary":"Error X.XX","id":"paths/~1increment/post/responses/200/content/application~1json/examples/Error X.XX"},"paths/~1recurring/post/requestBody/content/application~1json/examples/Payment":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","payment_type":"1-click","recurring_token":"7ats8da7sd8-a66dfa7-a9s9das89t","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"01","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Payment","summary":"Payment","id":"paths/~1recurring/post/requestBody/content/application~1json/examples/Payment"},"paths/~1recurring/post/requestBody/content/application~1json/examples/Product-based payment":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","payment_type":"1-click","recurring_token":"7ats8da7sd8-a66dfa7-a9s9das89t","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"01","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Product-based payment","summary":"Product-based payment","id":"paths/~1recurring/post/requestBody/content/application~1json/examples/Product-based payment"},"paths/~1recurring/post/requestBody/content/application~1json/examples/Subscription payment":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"83b19018-cbc4-45f0-899a-dda84fd2705e","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","payment_type":"1-click","recurring_token":"7ats8da7sd8-a66dfa7-a9s9das89t","retry_attempt":3,"force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"06","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1recurring/post/requestBody/content/application~1json/examples/Subscription payment"},"paths/~1recurring/post/responses/200/content/application~1json/examples/Success":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"settle_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"recurring-auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"recurring-auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"01","flow":"frictionless","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Success","summary":"Success","id":"paths/~1recurring/post/responses/200/content/application~1json/examples/Success"},"paths/~1recurring/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1recurring/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1recurring/post/responses/200/content/application~1json/examples/Error X.XX":{"value":{"error":{"code":"3.02","messages":["Insufficient funds"],"recommended_message_for_user":"The card balance has insufficient funds."}},"key":"Error X.XX","summary":"Error X.XX","id":"paths/~1recurring/post/responses/200/content/application~1json/examples/Error X.XX"},"paths/~1resign/post/requestBody/content/application~1json/examples/Payment":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","recurring_token":"7ats8da7sd8-a66dfa7-a9s9das89t","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"05","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_cvv":"123","dynamic_descriptor":{"suffix":"PRODUCTX"},"industry_data":{"type":"car_rental","car_rental":{"agreement_number":"BKID12345","renter_name":"John","pick_up_date":"2026-03-01T11:00:00Z","drop_off_date":"2026-03-05T16:30:00Z","refundability":"partially_refundable","rate":1000,"rate_indicator":"D","days_rented":"10","customer_service_toll_free_number":"8001010123","rental_class_id":"0001","tax_exempt_indicator":"Y","fuel_charges":2000,"insurance_charges":2300,"no_show_indicator":"N","one_way_drop_off_charges":50000,"return_location_id":"AB1234","pick_up_location":{"street_line_1":"1 Example Street","state":"CA","city":"San Francisco","country":"USA","postal":"SW1A1AA"},"drop_off_location":{"street_line_1":"1 Example Street","state":"CA","city":"San Francisco","country":"USA","postal":"SW1A1AA"},"distance_limit":{"limit":500,"unit":"miles","additional_distance_cost":{"amount":150,"currency":"USD"}}}},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","zip_code":"90210","country":"USA","state":"WA","city":"Baltimore","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Payment","summary":"Payment","id":"paths/~1resign/post/requestBody/content/application~1json/examples/Payment"},"paths/~1resign/post/requestBody/content/application~1json/examples/Product-based payment":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","recurring_token":"7ats8da7sd8-a66dfa7-a9s9das89t","force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"05","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_cvv":"123","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Product-based payment","summary":"Product-based payment","id":"paths/~1resign/post/requestBody/content/application~1json/examples/Product-based payment"},"paths/~1resign/post/requestBody/content/application~1json/examples/Subscription payment":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"83b19018-cbc4-45f0-899a-dda84fd2705e","currency":"EUR","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","recurring_token":"7ats8da7sd8-a66dfa7-a9s9das89t","retry_attempt":3,"force3ds":false,"external_mpi_data":{"three_ds_version":"2.2.0","eci":"02","cryptogram":"QURZRU4gM0RTMiBURVNUIENBVlY=","ds_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","cryptogram_algorithm":"A","three_ds_flow":"frictionless","three_ds_server_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","acs_challenge_mandated_ind":"Y","transaction_challenge_exemption":"05","authentication_response":"Y","authentication_timestamp":"2025-12-05T12:00:00.000Z","ds_transaction_reason":"01","acs_transaction_id":"6edcc246-23ee-4e94-ac5d-8ae620bea7d9","authentication_method":["02","03"],"challenge_cancel_ind":"01"},"customer_account_id":"4245d7b0-a84c-4623-91ff-e9de0254735b","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+12025550123","card_cvv":"123","dynamic_descriptor":{"suffix":"PRODUCTX"},"ip_address":"203.0.113.0","traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","country":"USA","state":"WA","city":"Baltimore","zip_code":"90210","address":"Apt. 123, 321 Main Street","shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","address":"123 Main St"},"language":"en","website":"merchant.example","device":"iPhone 8 iOS 12.0","device_sessions":[{"id":"dsid_3a20_f9c1_4cd8_89d3_1c5","provider":"checkout"}],"platform":"WEB","header_accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng","header_accept_language":"en-US","browser_color_depth":32,"browser_screen_height":1920,"browser_screen_width":1280,"browser_java_enabled":true,"time_zone_offset":-120,"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"payment_type_data":{"panama_id":"81234567"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1resign/post/requestBody/content/application~1json/examples/Subscription payment"},"paths/~1resign/post/responses/200/content/application~1json/examples/Success":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"settle_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"02","flow":"none","exception":"transaction_risk_assessment"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"verify_url":"https://merchant.example/verify","redirect_url":"https://merchant.example/redirect","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Success","summary":"Success","id":"paths/~1resign/post/responses/200/content/application~1json/examples/Success"},"paths/~1resign/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1resign/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1resign/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1resign/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1resign/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1resign/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1resign/post/responses/200/content/application~1json/examples/Error X.XX":{"value":{"error":{"code":"3.02","messages":["Insufficient funds"],"recommended_message_for_user":"The card balance has insufficient funds."}},"key":"Error X.XX","summary":"Error X.XX","id":"paths/~1resign/post/responses/200/content/application~1json/examples/Error X.XX"},"paths/~1refund/post/requestBody/content/application~1json/examples/Refund":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"refund_reason_code":"0022"},"key":"Refund","summary":"Refund","id":"paths/~1refund/post/requestBody/content/application~1json/examples/Refund"},"paths/~1refund/post/responses/200/content/application~1json/examples/Success":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"processing","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"07","flow":"unspecified","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Success","summary":"Success","id":"paths/~1refund/post/responses/200/content/application~1json/examples/Success"},"paths/~1refund/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1refund/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1refund/post/responses/200/content/application~1json/examples/Error X.XX":{"value":{"error":{"code":"3.02","messages":["Insufficient funds"],"recommended_message_for_user":"The card balance has insufficient funds."}},"key":"Error X.XX","summary":"Error X.XX","id":"paths/~1refund/post/responses/200/content/application~1json/examples/Error X.XX"},"paths/~1void/post/responses/200/content/application~1json/examples/Success":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"settle_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"05","flow":"frictionless","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Success","summary":"Success","id":"paths/~1void/post/responses/200/content/application~1json/examples/Success"},"paths/~1void/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1void/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1void/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1void/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1void/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1void/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1void/post/responses/200/content/application~1json/examples/Error X.XX":{"value":{"error":{"code":"3.02","messages":["Insufficient funds"],"recommended_message_for_user":"The card balance has insufficient funds."}},"key":"Error X.XX","summary":"Error X.XX","id":"paths/~1void/post/responses/200/content/application~1json/examples/Error X.XX"},"paths/~1settle/post/responses/200/content/application~1json/examples/Success":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"status":"settle_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299"}},"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"The problem here lies with the data format and accuracy, validation error on the acquiring side","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"06","flow":"challenge","exception":"transaction_risk_assessment"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"pass"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Success","summary":"Success","id":"paths/~1settle/post/responses/200/content/application~1json/examples/Success"},"paths/~1settle/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1settle/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1settle/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1settle/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1settle/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1settle/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1settle/post/responses/200/content/application~1json/examples/Error X.XX":{"value":{"error":{"code":"3.02","messages":["Insufficient funds"],"recommended_message_for_user":"The card balance has insufficient funds."}},"key":"Error X.XX","summary":"Error X.XX","id":"paths/~1settle/post/responses/200/content/application~1json/examples/Error X.XX"},"paths/~1status/post/responses/200/content/application~1json/examples/Success":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"authorized_amount":100,"status":"auth_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook"},"error":{"code":"3.08","messages":["Do not honor"],"recommended_message_for_user":"Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","authorization_type":"final","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"}},"error":{"code":"3.08","messages":["Do not honor"],"recommended_message_for_user":"Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","authorization_type":"final","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"}},"error":{"code":"3.08","messages":["Do not honor"],"recommended_message_for_user":"Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"05","flow":"frictionless","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"review"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"<chargeback_id_value_#1>":{"id":12345,"dispute_date":"2026-07-10 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"verify_url":"https://merchant.example/verify","redirect_url":"https://merchant.example/redirect","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Success","summary":"Success","id":"paths/~1status/post/responses/200/content/application~1json/examples/Success"},"paths/~1status/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1status/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1status/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1status/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1status/post/responses/200/content/application~1json/examples/Error X.XX":{"value":{"error":{"code":"2.01","messages":["Invalid data"],"recommended_message_for_user":"Double-check and correct payment details."}},"key":"Error X.XX","summary":"Error X.XX","id":"paths/~1status/post/responses/200/content/application~1json/examples/Error X.XX"},"paths/~1arn-code/post/responses/200/content/application~1json/examples/Success":{"value":{"arn_codes":[{"arn_code":"24871153022084127852235","created_at":"2026-07-15 11:45:30","amount_refunded":100,"currency":"USD","transaction_status":"success"}]},"key":"Success","summary":"Success","id":"paths/~1arn-code/post/responses/200/content/application~1json/examples/Success"},"paths/~1arn-code/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1arn-code/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1arn-code/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1arn-code/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1arn-code/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1arn-code/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/CardsOrderStatus/post/requestBody/content/application~1json/examples/Updated card order":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","product_name":"Luxury product","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","marketing_amount":0,"marketing_currency":"USD","refunded_amount":0,"authorized_amount":100,"status":"auth_ok","auth_code":"2w9m8","payment_type":"1-click","payment_method":"card","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","descriptor":"google.com","mid":"bank-mid-1","ip_address":"8.8.8.8","traffic_source":"facebook"},"error":{"code":"3.08","messages":["Do not honor"],"recommended_message_for_user":"Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction"},"transaction":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","authorization_type":"final","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","country":"USA","city":"Boston","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"}},"error":{"code":"3.08","messages":["Do not honor"],"recommended_message_for_user":"Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"},"transactions":{"<transaction_id_value_#1>":{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","marketing_amount":0,"marketing_currency":"USD","operation":"auth","status":"processing","authorization_type":"final","scheme_transaction_id":"MDSCAJVIJ1201","transaction_link_id":"A1bCDefGhijkLmNopQrStu","descriptor":"google.com","billing_details":{"address":"21 Bedford Ave","city":"Boston","country":"USA","state":"NY","zip":"91191"},"refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"},"card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_category":"CONSUMER","is_reloadable":true,"card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435","card_token":{"token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","original_payment_method":"apple-pay"}},"error":{"code":"3.08","messages":["Do not honor"],"recommended_message_for_user":"Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction","merchant_advice_code":"30"},"payment_account_reference":"PAR_1A2B3C4D5E6F7G8H9","arn_code":"24871153022084127852235","rrn_code":"100034876543"}},"three_ds":{"eci":"05","flow":"frictionless","exception":"low_value"},"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","legal_entity_id":"12560","legal_entity_name":"SOLIDGATE TECH LIMITED"}]},"antifraud_result":{"pre_auth":"review"},"verification_result":{"avs_result":"matched","cvv_result":"matched","ani":{"status":"performed","full_name_match":"matched","first_name_match":"partially_matched","last_name_match":"not_matched"}},"chargebacks":{"id":147712,"dispute_date":"2026-07-11 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"2nd_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"2nd_chb","status":"reversed","arn_code":"24871153022084127852235"}]},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"},"verify_url":"https://merchant.example/verify","redirect_url":"https://merchant.example/redirect","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Updated card order","summary":"Updated card order","id":"paths/CardsOrderStatus/post/requestBody/content/application~1json/examples/Updated card order"},"paths/NetworkTokenCreated/post/requestBody/content/application~1json/examples/Created network token":{"value":{"card_id":"123e4567-e89b-12d3-a456-426614174000","tokenization_type":"vts","status":"INACTIVE","created_at":"2025-08-17 11:45:30","updated_at":"2025-08-17 11:45:30"},"key":"Created network token","summary":"Created network token","id":"paths/NetworkTokenCreated/post/requestBody/content/application~1json/examples/Created network token"},"paths/NetworkTokenUpdated/post/requestBody/content/application~1json/examples/Updated network token":{"value":{"card_id":"123e4567-e89b-12d3-a456-426614174000","tokenization_type":"vts","status":"INACTIVE","created_at":"2025-08-17 11:45:30","updated_at":"2025-08-17 11:45:30"},"key":"Updated network token","summary":"Updated network token","id":"paths/NetworkTokenUpdated/post/requestBody/content/application~1json/examples/Updated network token"},"paths/Chargeback/post/requestBody/content/application~1json/examples/Received dispute":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":100,"currency":"USD","status":"settle_ok"},"chargeback":{"id":147712,"dispute_date":"2026-07-11 00:00:00","settlement_date":"2026-07-11 00:00:00","amount":100,"currency":"USD","type":"1st_chb","status":"in_progress","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","available_actions":["enrich_evidence","provide_evidence"]},"chargeback_flow":[{"id":12345,"date":"2026-07-10 00:00:00","updated_date":"2026-07-11 00:00:00","settlement_date":"2026-07-10 00:00:00","deadline_date":"2026-07-12 00:00:00","amount":100,"dispute_amount":0,"currency":"USD","type":"1st_chb","status":"in_progress","represented_by":"automation","arn_code":"24871153022084127852235"}]},"key":"Received dispute","summary":"Received dispute","id":"paths/Chargeback/post/requestBody/content/application~1json/examples/Received dispute"},"paths/CardPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert":{"value":{"order":{"id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2026-07-15 11:45:30","amount":100,"currency":"USD","status":"approved"},"alert":{"id":"83b19018-cbc4-4df0-899a-dda84fd2705e","amount":200,"currency":"EUR","provider_name":"ethoca","alert_date":"2026-07-17 11:01:03","created_at":"2026-07-17 11:03:30","updated_at":"2026-07-17 11:03:31","alert_type":"init-refund","outcome":"reversed"}},"key":"Received prevention alert","summary":"Received prevention alert","id":"paths/CardPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert"},"paths/FraudAlert/post/requestBody/content/application~1json/examples/Received fraud alert":{"value":{"id":9147712,"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-03-24 14:22:19","updated_at":"2025-03-24 14:22:19","fraud_amount":2575,"fraud_currency":"USD","fraud_amount_usd":12367,"fraud_type":"6","fraud_report_day":"2025-03-24 14:22:18","card_scheme":"VISA","reason_code_description":"Fraudulent use of account number"},"key":"Received fraud alert","summary":"Received fraud alert","id":"paths/FraudAlert/post/requestBody/content/application~1json/examples/Received fraud alert"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/PayPal":{"value":{"payment_method":"paypal-vault","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"USD","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"PayPal","summary":"PayPal","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/PayPal"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Alipay":{"value":{"payment_method":"alipay","order_id":"order_20251221_CNY_8900","amount":8900,"currency":"CNY","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_first_name":"Wei","customer_last_name":"Zhang","customer_phone":"+8613812345678","item_category":"digital_goods","billing_address":{"country":"CHN","city":"Shanghai","zip":"200000","line1":"123 Nanjing Road","line2":"Apt. 456"},"language":"en","ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"CNY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Alipay","summary":"Alipay","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Alipay"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik":{"value":{"payment_method":"blik","payment_method_flow":"direct","future_usage":{"payment_type":"unscheduled"},"payment_type_data":{"blik_code":"123456"},"order_id":"order_sub_20240401","amount":2999,"currency":"PLN","order_description":"Monthly Premium Plan","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"customer@example.pl","customer_first_name":"Nikola","customer_last_name":"Tesla","billing_address":{"country":"POL"},"ip_address":"178.12.34.56","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Blik","summary":"Blik","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik Pay Later":{"value":{"payment_method":"blik-bnpl","payment_method_flow":"redirect","order_id":"order_blik_pay_later_001","amount":50000,"currency":"PLN","order_description":"Order #blik_pay_later_001","customer_email":"buyer@example.pl","customer_first_name":"Jakub","customer_last_name":"Kowalski","ip_address":"83.25.101.14","platform":"WEB","billing_address":{"country":"POL"},"future_usage":{"payment_type":"one-time"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Blik Pay Later","summary":"Blik Pay Later","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Blik Pay Later"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Bizum":{"value":{"payment_method":"bizum","order_id":"order_20251021_EUR_400","amount":400,"currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2025-10-21 13:49:00","customer_account_id":"user_id_12345","customer_email":"test@merchant.example","customer_first_name":"Carlos","customer_last_name":"García","customer_phone":"+34700000000","item_category":"digital_goods","billing_address":{"country":"ESP","city":"Madrid","zip":"28001","line1":"Calle Gran Vía 123","line2":"Piso 4"},"language":"en","ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"ES2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Bizum","summary":"Bizum","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Bizum"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Boleto":{"value":{"payment_method":"boleto","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","payment_method_flow":"redirect","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Boleto","summary":"Boleto","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Boleto"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Cash App Pay":{"value":{"payment_method":"cashapp","order_id":"order_20260813_USD_1020","amount":1020,"currency":"USD","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2026-08-13 10:31:44","customer_account_id":"user_id_12345","customer_email":"example@example.com","customer_first_name":"Alex","customer_last_name":"Johnson","customer_phone":"+12025550123","billing_address":{"country":"USA","state":"NY","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"language":"en","ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2026","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Cash App Pay","summary":"Cash App Pay","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Cash App Pay"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Efecty":{"value":{"payment_method":"efecty","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":10000,"currency":"COP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"COL","state":"Cundinamarca","city":"Bogotá","zip":"54321","line1":"Carrera 7 # 123","line2":"Apto 456"},"shipping_address":{"country":"COL","state":"Antioquia","city":"Medellín","zip":"12345","line1":"Calle 45 # 789","line2":"Unit 789"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"colombia_cc":"42141221"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Efecty","summary":"Efecty","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Efecty"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/GCash":{"value":{"payment_method":"gcash","order_id":"order_20251103_PHP_2575","amount":2575,"currency":"PHP","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2025-11-03 15:51:00","customer_account_id":"user_id_67890","customer_email":"example.user@example.com","customer_first_name":"Maria","customer_last_name":"Santos","customer_phone":"+639171234567","item_category":"digital_goods","billing_address":{"country":"PHL","city":"Manila","zip":"1000","line1":"123 Rizal Avenue","line2":"Unit 5B"},"language":"en","ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"PH2025","partner_id":"123989"},"return_url":"https://merchant.example"},"key":"GCash","summary":"GCash","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/GCash"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Ideal":{"value":{"payment_method":"ideal","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Ideal","summary":"Ideal","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Ideal"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Klarna":{"value":{"payment_method":"klarna-network","order_id":"order_kln_001","amount":9900,"currency":"EUR","order_description":"Order #kln_001","order_date":"2026-05-19 10:31:44","customer_account_id":"user_id_67890","customer_email":"buyer@example.com","customer_first_name":"Emma","customer_last_name":"Johansson","customer_date_of_birth":"1990-03-15","customer_phone":"+46701234567","item_category":"physical_goods","billing_address":{"country":"SWE","state":"Stockholm","city":"Stockholm","zip":"111 57","line1":"Sveavägen 1","line2":"Apt. 12"},"shipping_address":{"country":"SWE","state":"Stockholm","city":"Stockholm","zip":"111 57","line1":"Sveavägen 1","line2":"Apt. 12"},"future_usage":{"payment_type":"one-time"},"payment_type_data":{"klarna_network_session_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.klarna_session_token_example","klarna_network_data":"{\"order_lines\":[{\"name\":\"Premium jacket\",\"quantity\":1,\"unit_price\":9900,\"total_amount\":9900}]}","sweden_pin":"19811228-9874","klarna_originators":[{"name":"SHOPIFY","session_reference":"shop-session-abc123","module_name":"shopify-plugin","module_version":"1.0.0"}]},"language":"en","ip_address":"82.115.34.21","platform":"WEB","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36","order_metadata":{"coupon_code":"SPRING2026","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/return"},"key":"Klarna","summary":"Klarna","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Klarna"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/MB WAY":{"value":{"payment_method":"mbway","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"PRT"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"MB WAY","summary":"MB WAY","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/MB WAY"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Mercado Pago":{"value":{"payment_method":"mercadopago","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"argentina_dni":42243309},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Mercado Pago","summary":"Mercado Pago","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Mercado Pago"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/MobilePay":{"value":{"payment_method":"mobilepay","order_id":"order_mp_001","amount":9900,"currency":"DKK","future_usage":{"payment_type":"one-time"},"order_description":"Order #mp_001","customer_email":"buyer@example.dk","customer_first_name":"Lars","customer_last_name":"Jensen","ip_address":"195.68.45.12","platform":"WEB","billing_address":{"country":"DNK"}},"key":"MobilePay","summary":"MobilePay","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/MobilePay"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Multibanco":{"value":{"payment_method":"multibanco","order_id":"order_abc123","amount":2490,"currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Order #abc123","order_date":"2026-04-23 10:31:44","customer_account_id":"user_id_abc123","customer_email":"buyer@example.pt","customer_first_name":"João","customer_last_name":"Silva","customer_phone":"+351912345678","billing_address":{"country":"PRT","city":"Lisboa","zip":"1250-096","line1":"Avenida da Liberdade 100","line2":"3º Esq."},"language":"en","ip_address":"178.12.34.56","platform":"WEB","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36","order_metadata":{"coupon_code":"PT2026","partner_id":"123989"}},"key":"Multibanco","summary":"Multibanco","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Multibanco"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/OXXO":{"value":{"payment_method":"oxxo","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"MXN","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_email":"example@example.com","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"mexico_curp":"ZAZD801124MBSYQN13"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"OXXO","summary":"OXXO","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/OXXO"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Pay by Bank":{"value":{"payment_method":"openbanking","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"DEU","state":"BE","city":"Berlin","zip":"10115","line1":"Alexanderplatz 1","line2":"Apartment 123"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Pay by Bank","summary":"Pay by Bank","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Pay by Bank"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix QR":{"value":{"payment_method":"pix-qr","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Pix QR","summary":"Pix QR","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix QR"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix Automático":{"value":{"payment_method":"pix-automatico","order_id":"order_1234567890","amount":1000,"currency":"BRL","future_usage":{"payment_type":"recurring","billing_period":{"unit":"day","value":7},"max_amount":10000},"order_description":"Premium package","customer_email":"example@example.com","customer_first_name":"John","customer_last_name":"Doe","ip_address":"203.0.113.0","platform":"WEB","billing_address":{"country":"BRA"},"payment_type_data":{"brazil_cpf":"12345678901"}},"key":"Pix Automático","summary":"Pix Automático","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Pix Automático"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Przelewy24":{"value":{"payment_method":"przelewy24","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"PLN","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Przelewy24","summary":"Przelewy24","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Przelewy24"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/PSE":{"value":{"payment_method":"pse","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":10000,"currency":"COP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"COL","state":"Cundinamarca","city":"Bogotá","zip":"54321","line1":"Carrera 7 # 123","line2":"Apto 456"},"shipping_address":{"country":"COL","state":"Antioquia","city":"Medellín","zip":"12345","line1":"Calle 45 # 789","line2":"Unit 789"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"colombia_cc":"42141221"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"PSE","summary":"PSE","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/PSE"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Sencillito":{"value":{"payment_method":"sencillito","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1000,"currency":"CLP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Isabella","customer_last_name":"Martinez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"123456","line1":"123 Main Street","line2":"Apartment 456"},"shipping_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"654321","line1":"789 Elm Street","line2":"Unit 789"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"chile_ci":"5633554V"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Sencillito","summary":"Sencillito","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Sencillito"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Servipag":{"value":{"payment_method":"servipag","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1000,"currency":"CLP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Isabella","customer_last_name":"Martinez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"123456","line1":"123 Main Street","line2":"Apartment 456"},"shipping_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"654321","line1":"789 Elm Street","line2":"Unit 789"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"chile_ci":"5633554V"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Servipag","summary":"Servipag","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Servipag"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/SmartPix":{"value":{"payment_method":"pix","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"SmartPix","summary":"SmartPix","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/SmartPix"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/UPI":{"value":{"payment_method":"upi","payment_method_flow":"redirect","order_id":"order_rec_001","amount":29900,"currency":"INR","order_description":"Monthly subscription","customer_email":"buyer@example.in","customer_first_name":"Arjun","customer_last_name":"Sharma","customer_phone":"+919876543210","ip_address":"103.21.56.78","platform":"WEB","billing_address":{"country":"IND","zip":"110001"},"future_usage":{"payment_type":"recurring","max_amount":99900,"billing_period":{"unit":"month","value":1}},"return_url":"https://merchant.example.com/return"},"key":"UPI","summary":"UPI","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/UPI"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Webpay":{"value":{"payment_method":"webpay","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1000,"currency":"CLP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Isabella","customer_last_name":"Martinez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"123456","line1":"123 Main Street","line2":"Apartment 456"},"shipping_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"654321","line1":"789 Elm Street","line2":"Unit 789"},"language":"en","ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"chile_ci":"5633554V"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Webpay","summary":"Webpay","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Webpay"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/WeChat Pay":{"value":{"payment_method":"wechatpay","order_id":"order_20251221_CNY_8901","amount":8900,"currency":"CNY","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_first_name":"Li","customer_last_name":"Wang","customer_phone":"+8613812345678","item_category":"digital_goods","billing_address":{"country":"CHN","city":"Beijing","zip":"100000","line1":"456 Chang'an Avenue","line2":"Building 3"},"language":"en","ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"WX2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"WeChat Pay","summary":"WeChat Pay","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/WeChat Pay"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PayPal":{"value":{"payment_method":"paypal-vault","order_id":"f3g4h5i6-7j8k-90l1-m2n3-456op789qr12","product_id":"g4h5i6j7-k8l9-01m2-n345-op678qr901st","currency":"USD","order_description":"Platinum plan","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":10005,"line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":91191,"line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment PayPal","summary":"Product-based payment PayPal","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PayPal"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Alipay":{"value":{"payment_method":"alipay","order_id":"order_prod_20251221_CNY_001","product_id":"g4h5i6j7-k8l9-01m2-n345-op678qr901st","currency":"CNY","future_usage":{"payment_type":"one-time"},"order_description":"Platinum plan","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"test@merchant.example","customer_first_name":"Wei","customer_last_name":"Zhang","customer_phone":"+8613812345678","item_category":"digital_goods","billing_address":{"country":"CHN","city":"Shanghai","zip":"200000","line1":"123 Nanjing Road","line2":"Apt. 456"},"ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Product-based payment Alipay","summary":"Product-based payment Alipay","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Alipay"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik":{"value":{"payment_method":"blik","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"PLN","order_description":"Deluxe membership","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"MOB","user_agent":"Mozilla/5.0","payment_type_data":{"blik_code":"777111"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment Blik","summary":"Product-based payment Blik","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik Pay Later":{"value":{"payment_method":"blik-bnpl","payment_method_flow":"redirect","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"PLN","order_description":"Deluxe membership","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"buyer@example.pl","customer_first_name":"Jakub","customer_last_name":"Kowalski","customer_date_of_birth":"1988-11-21","customer_phone":"+48123456789","item_category":"digital_goods","billing_address":{"country":"POL","state":"MZ","city":"Warsaw","zip":"00-001","line1":"ul. Marszałkowska 1"},"ip_address":"83.25.101.14","platform":"WEB","user_agent":"Mozilla/5.0","future_usage":{"payment_type":"one-time"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment Blik Pay Later","summary":"Product-based payment Blik Pay Later","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Blik Pay Later"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Boleto":{"value":{"payment_method":"boleto","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","payment_method_flow":"redirect","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment Boleto","summary":"Product-based payment Boleto","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Boleto"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Efecty":{"value":{"payment_method":"efecty","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"COP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"COL","state":"Cundinamarca","city":"Bogotá","zip":"54321","line1":"Carrera 7 # 123","line2":"Apto 456"},"shipping_address":{"country":"COL","state":"Antioquia","city":"Medellín","zip":"12345","line1":"Calle 45 # 789","line2":"Unit 789"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"colombia_cc":"42141221"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment Efecty","summary":"Product-based payment Efecty","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Efecty"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment GCash":{"value":{"payment_method":"gcash","order_id":"order_prod_20251103_PHP_001","product_id":"g4h5i6j7-k8l9-01m2-n345-op678qr901st","currency":"PHP","future_usage":{"payment_type":"one-time"},"order_description":"Platinum plan","order_date":"2025-11-03 15:51:00","customer_account_id":"user_id_67890","customer_email":"example.user@example.com","customer_first_name":"Maria","customer_last_name":"Santos","customer_phone":"+639171234567","item_category":"digital_goods","billing_address":{"country":"PHL","city":"Manila","zip":"1000","line1":"123 Rizal Avenue","line2":"Unit 5B"},"ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example"},"key":"Product-based payment GCash","summary":"Product-based payment GCash","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment GCash"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Ideal":{"value":{"payment_method":"ideal","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment Ideal","summary":"Product-based payment Ideal","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Ideal"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Klarna":{"value":{"payment_method":"klarna-network","order_id":"order_kln_prod_001","product_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2026-05-19 10:31:44","customer_account_id":"user_id_67890","customer_email":"buyer@example.com","customer_first_name":"Emma","customer_last_name":"Johansson","customer_date_of_birth":"1990-03-15","customer_phone":"+46701234567","item_category":"physical_goods","billing_address":{"country":"SWE","state":"Stockholm","city":"Stockholm","zip":"111 57","line1":"Sveavägen 1","line2":"Apt. 12"},"shipping_address":{"country":"SWE","state":"Stockholm","city":"Stockholm","zip":"111 57","line1":"Sveavägen 1","line2":"Apt. 12"},"payment_type_data":{"klarna_network_session_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.klarna_session_token_example","klarna_network_data":"{\"order_lines\":[{\"name\":\"Premium package\",\"quantity\":1,\"unit_price\":9900,\"total_amount\":9900}]}","sweden_pin":"19811228-9874","klarna_originators":[{"name":"SHOPIFY","session_reference":"shop-session-abc123","module_name":"shopify-plugin","module_version":"1.0.0"}]},"language":"en","ip_address":"82.115.34.21","platform":"WEB","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36","order_metadata":{"coupon_code":"SPRING2026","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/return"},"key":"Product-based payment Klarna","summary":"Product-based payment Klarna","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Klarna"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MB WAY":{"value":{"payment_method":"mbway","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"PRT"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"}},"key":"Product-based payment MB WAY","summary":"Product-based payment MB WAY","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MB WAY"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago":{"value":{"payment_method":"mercadopago","order_id":"u4v5w6x7-8y9z-01a2-b3c4-567de890fg12","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"BRL","order_description":"Premium Gold membership","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1989-09-21","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":10005,"line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":91191,"line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"argentina_dni":42243309},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment Mercado Pago","summary":"Product-based payment Mercado Pago","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MobilePay":{"value":{"payment_method":"mobilepay","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"DKK","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_date":"2026-06-10 10:31:44","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"buyer@example.dk","customer_first_name":"Lars","customer_last_name":"Jensen","customer_date_of_birth":"1985-03-15","customer_phone":"+4512345678","item_category":"digital_goods","billing_address":{"country":"DNK","city":"Copenhagen","zip":"1050","line1":"Vesterbrogade 1","line2":"2. tv"},"shipping_address":{"country":"DNK","city":"Copenhagen","zip":"1050","line1":"Vesterbrogade 1","line2":"2. tv"},"ip_address":"195.68.45.12","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"DK2026","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment MobilePay","summary":"Product-based payment MobilePay","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment MobilePay"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Multibanco":{"value":{"payment_method":"multibanco","order_id":"order_product_abc123","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"EUR","order_description":"Order #abc123","order_date":"2026-04-23 10:31:44","customer_account_id":"user_id_abc123","customer_email":"buyer@example.pt","customer_first_name":"João","customer_last_name":"Silva","customer_phone":"+351912345678","item_category":"digital_goods","billing_address":{"country":"PRT","city":"Lisboa","zip":"1250-096","line1":"Avenida da Liberdade 100","line2":"3º Esq."},"language":"en","ip_address":"178.12.34.56","platform":"WEB","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36","order_metadata":{"coupon_code":"PT2026","partner_id":"123989"}},"key":"Product-based payment Multibanco","summary":"Product-based payment Multibanco","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Multibanco"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment OXXO":{"value":{"payment_method":"oxxo","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"MXN","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"d4e5f6g7-h8i9-j0k1-234lmn567op8","customer_email":"example@example.com","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"mexico_curp":"ZAZD801124MBSYQN13"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment OXXO","summary":"Product-based payment OXXO","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment OXXO"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pay by Bank":{"value":{"payment_method":"openbanking","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"EUR","order_description":"Premium package","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"DEU","state":"BE","city":"Berlin","zip":"10115","line1":"Alexanderplatz 1","line2":"Apartment 123"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment Pay by Bank","summary":"Product-based payment Pay by Bank","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pay by Bank"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pix QR":{"value":{"payment_method":"pix-qr","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment Pix QR","summary":"Product-based payment Pix QR","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Pix QR"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Przelewy24":{"value":{"payment_method":"przelewy24","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"PLN","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment Przelewy24","summary":"Product-based payment Przelewy24","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Przelewy24"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PSE":{"value":{"payment_method":"pse","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"COP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"COL","state":"Cundinamarca","city":"Bogotá","zip":"54321","line1":"Carrera 7 # 123","line2":"Apto 456"},"shipping_address":{"country":"COL","state":"Antioquia","city":"Medellín","zip":"12345","line1":"Calle 45 # 789","line2":"Unit 789"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"colombia_cc":"42141221"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment PSE","summary":"Product-based payment PSE","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment PSE"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Sencillito":{"value":{"payment_method":"sencillito","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"CLP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Isabella","customer_last_name":"Martinez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"123456","line1":"123 Main Street","line2":"Apartment 456"},"shipping_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"654321","line1":"789 Elm Street","line2":"Unit 789"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"chile_ci":"5633554V"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment Sencillito","summary":"Product-based payment Sencillito","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Sencillito"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Servipag":{"value":{"payment_method":"servipag","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"CLP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Isabella","customer_last_name":"Martinez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"123456","line1":"123 Main Street","line2":"Apartment 456"},"shipping_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"654321","line1":"789 Elm Street","line2":"Unit 789"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"chile_ci":"5633554V"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment Servipag","summary":"Product-based payment Servipag","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Servipag"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment SmartPix":{"value":{"payment_method":"pix","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment SmartPix","summary":"Product-based payment SmartPix","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment SmartPix"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment UPI":{"value":{"payment_method":"upi","payment_method_flow":"direct","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"INR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+919876543210","item_category":"digital_goods","billing_address":{"country":"IND","state":"Maharashtra","city":"Mumbai","zip":"400001","line1":"123 Main St.","line2":"Apt. 123"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","future_usage":{"payment_type":"unscheduled"},"payment_type_data":{"india_vpa":"1234567890@abc"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment UPI","summary":"Product-based payment UPI","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment UPI"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Webpay":{"value":{"payment_method":"webpay","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"CLP","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"12345","customer_email":"example@example.com","customer_first_name":"Isabella","customer_last_name":"Martinez","customer_date_of_birth":"2000-11-21","customer_phone":"+15551234567","billing_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"123456","line1":"123 Main Street","line2":"Apartment 456"},"shipping_address":{"country":"CHL","state":"Region Metropolitana","city":"Santiago","zip":"654321","line1":"789 Elm Street","line2":"Unit 789"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"chile_ci":"5633554V"},"order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Product-based payment Webpay","summary":"Product-based payment Webpay","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment Webpay"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay":{"value":{"payment_method":"wechatpay","order_id":"order_prod_20251221_CNY_002","product_id":"g4h5i6j7-k8l9-01m2-n345-op678qr901st","currency":"CNY","future_usage":{"payment_type":"one-time"},"order_description":"Platinum plan","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"test@merchant.example","customer_first_name":"Li","customer_last_name":"Wang","customer_phone":"+8613812345678","item_category":"digital_goods","billing_address":{"country":"CHN","city":"Beijing","zip":"100000","line1":"456 Chang'an Avenue","line2":"Building 3"},"ip_address":"8.8.8.8","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"key":"Product-based payment WeChat Pay","summary":"Product-based payment WeChat Pay","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment PayPal":{"value":{"payment_method":"paypal-vault","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"USD","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":10005,"line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":91191,"line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Subscription payment PayPal","summary":"Subscription payment PayPal","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment PayPal"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Alipay":{"value":{"payment_method":"alipay","order_id":"order_sub_init_20251221_CNY_001","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"CNY","future_usage":{"payment_type":"unscheduled"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_email":"test@merchant.example","customer_first_name":"Wei","customer_last_name":"Zhang","customer_date_of_birth":"1988-11-21","customer_phone":"+8613800138000","item_category":"digital_goods","billing_address":{"country":"CHN","state":"11","city":"Beijing","zip":"100000","line1":"123 Wangfujing Street","line2":"Building A"},"shipping_address":{"country":"CHN","state":"31","city":"Shanghai","zip":"200000","line1":"777 Nanjing Road","line2":"Floor 5"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","order_metadata":{"coupon_code":"CNY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Subscription payment Alipay","summary":"Subscription payment Alipay","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Alipay"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Blik":{"value":{"payment_method":"blik","order_id":"order_sub_init_20240501","product_id":"b2c3d4e5-f6a7-4890-b123-456789abcdef","currency":"PLN","payment_method_flow":"direct","future_usage":{"payment_type":"unscheduled"},"payment_type_data":{"blik_code":"123456"},"order_description":"Monthly Premium Plan","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"customer@example.pl","billing_address":{"country":"POL"},"ip_address":"178.12.34.56","platform":"WEB","user_agent":"Mozilla/5.0"},"key":"Subscription payment Blik","summary":"Subscription payment Blik","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Blik"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment GCash":{"value":{"payment_method":"gcash","order_id":"order_sub_init_20251103_PHP_001","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"PHP","future_usage":{"payment_type":"unscheduled"},"order_description":"Premium package","order_date":"2025-11-03 15:51:00","customer_email":"example.user@example.com","customer_first_name":"Maria","customer_last_name":"Santos","customer_date_of_birth":"1990-05-15","customer_phone":"+639171234567","item_category":"digital_goods","billing_address":{"country":"PHL","state":"NCR","city":"Manila","zip":"1000","line1":"123 Rizal Avenue","line2":"Unit 5B"},"shipping_address":{"country":"PHL","state":"00","city":"Quezon City","zip":"1100","line1":"456 Commonwealth Avenue","line2":"Floor 10"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","order_metadata":{"coupon_code":"PH2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example"},"key":"Subscription payment GCash","summary":"Subscription payment GCash","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment GCash"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Klarna":{"value":{"payment_method":"klarna-network","order_id":"order_kln_sub_001","product_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","currency":"EUR","future_usage":{"payment_type":"recurring"},"order_description":"Monthly Premium subscription","order_date":"2026-05-19 10:31:44","customer_account_id":"user_id_67890","customer_email":"buyer@example.com","customer_first_name":"Emma","customer_last_name":"Johansson","customer_date_of_birth":"1990-03-15","customer_phone":"+46701234567","item_category":"digital_goods","billing_address":{"country":"SWE","state":"Stockholm","city":"Stockholm","zip":"111 57","line1":"Sveavägen 1","line2":"Apt. 12"},"shipping_address":{"country":"SWE","state":"Stockholm","city":"Stockholm","zip":"111 57","line1":"Sveavägen 1","line2":"Apt. 12"},"payment_type_data":{"klarna_network_session_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.klarna_session_token_example","klarna_network_data":"{\"order_lines\":[{\"name\":\"Monthly Premium subscription\",\"quantity\":1,\"unit_price\":9900,\"total_amount\":9900}]}","sweden_pin":"19811228-9874","klarna_originators":[{"name":"SHOPIFY","session_reference":"shop-session-abc123","module_name":"shopify-plugin","module_version":"1.0.0"}]},"language":"en","ip_address":"82.115.34.21","platform":"WEB","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36","order_metadata":{"subscription_id":"sub_12345","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/return"},"key":"Subscription payment Klarna","summary":"Subscription payment Klarna","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Klarna"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment MB WAY":{"value":{"payment_method":"mbway","order_id":"order_sub_init_20251221_EUR_001","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"EUR","future_usage":{"payment_type":"recurring"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"João","customer_last_name":"Silva","customer_date_of_birth":"1988-11-21","customer_phone":"+351912345678","item_category":"digital_goods","billing_address":{"country":"PRT","state":"11","city":"Lisbon","zip":"1000-001","line1":"123 Rua Augusta","line2":"Floor 2"},"shipping_address":{"country":"PRT","state":"11","city":"Porto","zip":"4000-001","line1":"777 Avenida da Boavista","line2":"Apt. 5B"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","order_metadata":{"coupon_code":"EUR2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Subscription payment MB WAY","summary":"Subscription payment MB WAY","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment MB WAY"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago":{"value":{"payment_method":"mercadopago","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1989-09-21","item_category":"digital_goods","billing_address":{"country":"USA","state":"WA","city":"New York","zip":10005,"line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":91191,"line1":"777 Main St.","line2":"Apt. 321"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"argentina_dni":42243309},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Subscription payment Mercado Pago","summary":"Subscription payment Mercado Pago","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático":{"value":{"payment_method":"pix-automatico","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","future_usage":{"max_amount":12000},"order_description":"Premium package","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","ip_address":"203.0.113.0","platform":"WEB","billing_address":{"country":"BRA"},"payment_type_data":{"brazil_cpf":"23100299900"}},"key":"Subscription payment Pix Automático","summary":"Subscription payment Pix Automático","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment SmartPix":{"value":{"payment_method":"pix","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","customer_phone":"+15551234567","item_category":"digital_goods","billing_address":{"country":"BRA","state":"SP","city":"São Paulo","zip":"04530","line1":"Avenida 1234","line2":"Apart 56"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","payment_type_data":{"brazil_cpf":"23100299900"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Subscription payment SmartPix","summary":"Subscription payment SmartPix","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment SmartPix"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment UPI":{"value":{"payment_method":"upi","payment_method_flow":"redirect","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"INR","future_usage":{"payment_type":"recurring","max_amount":99900},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1989-09-21","customer_phone":"+919876543210","item_category":"digital_goods","billing_address":{"country":"IND","state":"Maharashtra","city":"Mumbai","zip":"400001","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"IND","state":"Karnataka","city":"Bengaluru","zip":"560001","line1":"No. 1, MG Road","line2":"Near Brigade Road Junction"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Subscription payment UPI","summary":"Subscription payment UPI","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment UPI"},"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay":{"value":{"payment_method":"wechatpay","order_id":"order_sub_init_20251221_CNY_002","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"CNY","future_usage":{"payment_type":"unscheduled"},"order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_email":"test@merchant.example","customer_first_name":"Li","customer_last_name":"Wang","customer_date_of_birth":"1988-11-21","customer_phone":"+8613900139000","item_category":"digital_goods","billing_address":{"country":"CHN","state":"44","city":"Guangzhou","zip":"510000","line1":"456 Tianhe Road","line2":"Tower B"},"shipping_address":{"country":"CHN","state":"44","city":"Shenzhen","zip":"518000","line1":"888 Shennan Avenue","line2":"Unit 1001"},"ip_address":"203.0.113.0","platform":"WEB","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","order_metadata":{"coupon_code":"CNY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail","return_url":"https://merchant.example/success"},"key":"Subscription payment WeChat Pay","summary":"Subscription payment WeChat Pay","id":"paths/~1init-payment/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/PayPal":{"value":{"order":{"method":"paypal-vault","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"USD","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"paypal-vault","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"USD","status":"processing","type":"pay"},{"method":"paypal-vault","id":"another_unique_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"USD","status":"success","type":"refund"}],"pay_form":{"script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"PayPal","summary":"PayPal","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/PayPal"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Alipay":{"value":{"order":{"method":"alipay","order_id":"order_20251221_CNY_8900","created_at":"2025-10-20 16:28:25","updated_at":"2025-10-20 16:28:26","amount":8900,"currency":"CNY","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","ip_address":"8.8.8.8"},"transactions":[{"method":"alipay","id":"175f83e6-665d-49f2-b6f0-836690ea7e1e","created_at":"2025-10-20 16:28:25","amount":8900,"currency":"CNY","status":"processing","type":"pay"},{"method":"alipay","id":"a641818f-71a7-4bca-9402-3e9b7d4f0123","created_at":"2025-10-20 17:00:00","amount":500,"currency":"CNY","status":"success","type":"refund"}],"pay_form":{"return_url":"https://simulator-ui-stage.boku.com/redirect/cb17a7e6-6c4e-40a9-b3e9-f50e9d7d9d04","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"CNY2025","partner_id":"123989"}},"key":"Alipay","summary":"Alipay","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Alipay"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Blik":{"value":{"order":{"method":"blik","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"PLN","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"blik","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"PLN","status":"processing","type":"pay"},{"method":"blik","id":"another_unique_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"PLN","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Blik","summary":"Blik","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Blik"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Blik Pay Later":{"value":{"order":{"method":"blik-bnpl","order_id":"order_blik_pay_later_001","created_at":"2026-06-11 10:31:44","updated_at":"2026-06-11 10:31:44","amount":50000,"currency":"PLN","order_description":"Order #blik_pay_later_001","status":"processing","customer_email":"buyer@example.pl","ip_address":"83.25.101.14"},"transactions":[],"pay_form":{"token":"pft1ymnx6gq32ej3dvr9p45w","return_url":"https://e.blikpay.pl/blikweb/transaction/transaction_init/","script_url":""}},"key":"Blik Pay Later","summary":"Blik Pay Later","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Blik Pay Later"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Bizum":{"value":{"order":{"method":"bizum","order_id":"order_20251021_EUR_400","created_at":"2025-10-21 13:49:05","updated_at":"2025-10-21 13:49:19","amount":400,"currency":"EUR","order_description":"Premium package","status":"processing","customer_account_id":"user_id_12345","customer_email":"test@merchant.example","ip_address":"8.8.8.8"},"transactions":[{"method":"bizum","id":"06ce84ca-cd5d-42a5-adc9-19dba107036f","created_at":"2025-10-21 13:49:05","amount":400,"currency":"EUR","status":"processing","type":"pay"},{"method":"bizum","id":"c863151b-9d3e-7ade-b624-5g9f9f6h2345","created_at":"2025-10-21 14:20:00","amount":50,"currency":"EUR","status":"success","type":"refund"}],"pay_form":{"script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"ES2025","partner_id":"123989"}},"key":"Bizum","summary":"Bizum","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Bizum"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Boleto":{"value":{"order":{"method":"boleto","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"BRL","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"boleto","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"BRL","status":"processing","type":"pay"},{"method":"boleto","id":"another_unique_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"BRL","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"payment_type_data":{"amount":107.51,"currency":"BRL","expiration_date":"2025-06-04","image_url":"https://payment-provider.example/transaction/abc123","number":"3419109107005633044159101318002","type":"CUSTOM"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Boleto","summary":"Boleto","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Boleto"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Cash App Pay":{"value":{"order":{"method":"cashapp","order_id":"order_20260813_USD_1020","created_at":"2026-08-13 10:31:44","updated_at":"2026-08-13 10:31:58","amount":1020,"currency":"USD","order_description":"Premium package","status":"processing","customer_account_id":"user_id_12345","customer_email":"example@example.com","ip_address":"8.8.8.8"},"transactions":[{"method":"cashapp","id":"06ce84ca-cd5d-42a5-adc9-19dba107036f","created_at":"2026-08-13 10:31:44","amount":1020,"currency":"USD","status":"processing","type":"pay"},{"method":"cashapp","id":"c863151b-9d3e-7ade-b624-5g9f9f6h2345","created_at":"2026-08-13 11:20:00","amount":50,"currency":"USD","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2026","partner_id":"123989"}},"key":"Cash App Pay","summary":"Cash App Pay","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Cash App Pay"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Efecty":{"value":{"order":{"method":"efecty","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-21 11:21:30","updated_at":"2025-12-21 12:00:00","amount":10000,"currency":"COP","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"efecty","id":"unique_transaction_id_1","created_at":"2025-12-21 11:21:30","amount":5000,"currency":"COP","status":"processing","type":"pay"},{"method":"efecty","id":"unique_transaction_id_2","created_at":"2025-12-21 11:30:00","amount":5000,"currency":"COP","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Efecty","summary":"Efecty","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Efecty"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/GCash":{"value":{"order":{"method":"gcash","order_id":"order_20251103_PHP_2575","created_at":"2025-11-03 15:51:59","updated_at":"2025-11-03 15:52:10","amount":2575,"currency":"PHP","order_description":"Premium package","status":"processing","customer_account_id":"user_id_67890","customer_email":"example.user@example.com","ip_address":"8.8.8.8"},"transactions":[{"method":"gcash","id":"079c8d60-b9eb-4976-be49-e92c8e19a05d","created_at":"2025-11-03 15:51:59","amount":2575,"currency":"PHP","status":"processing","type":"pay"},{"method":"gcash","id":"d974262c-ae4f-8bef-c735-6h0g0g7i3456","created_at":"2025-11-03 16:45:00","amount":100,"currency":"PHP","status":"success","type":"refund"}],"pay_form":{"return_url":"https://g.alipayplus.com/link/redirect/auto/gotourl?url=https%3A%2F%2Fm.gcash.com%2F","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"PH2025","partner_id":"123989"}},"key":"GCash","summary":"GCash","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/GCash"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Ideal":{"value":{"order":{"method":"ideal","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"EUR","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"ideal","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"EUR","status":"processing","type":"pay"},{"method":"ideal","id":"another_id_here","created_at":"2025-12-28 12:00:00","amount":50,"currency":"EUR","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Ideal","summary":"Ideal","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Ideal"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Klarna":{"value":{"order":{"amount":9900,"currency":"EUR","order_id":"order_kln_001","status":"processing","method":"klarna-network","customer_account_id":"user_id_67890","customer_email":"buyer@example.com","ip_address":"82.115.34.21","order_description":"Order #kln_001","created_at":"2026-05-19 10:31:44","updated_at":"2026-05-19 10:31:44"},"pay_form":{"token":"pft1ymnx6gq32ej3dvr9p45w","return_url":"https://pay.klarna.com/eu/payments/...","script_url":""},"transactions":[],"order_metadata":{"coupon_code":"SPRING2026","partner_id":"123989"}},"key":"Klarna","summary":"Klarna","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Klarna"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/MB WAY":{"value":{"order":{"method":"mbway","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"EUR","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"mbway","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"EUR","status":"processing","type":"pay"}],"pay_form":{"return_url":"https://example.com/?return"}},"key":"MB WAY","summary":"MB WAY","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/MB WAY"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Mercado Pago":{"value":{"order":{"method":"mercadopago","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"BRL","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"mercadopago","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"BRL","status":"processing","type":"pay"},{"method":"mercadopago","id":"another_unique_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"BRL","status":"success","type":"refund"}],"pay_form":{"return_url":"https://example.com/?return"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Mercado Pago","summary":"Mercado Pago","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Mercado Pago"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/MobilePay":{"value":{"order":{"method":"mobilepay","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2026-06-10 10:31:44","updated_at":"2026-06-10 10:31:45","amount":9900,"currency":"DKK","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"buyer@example.dk","ip_address":"195.68.45.12"},"transactions":[{"method":"mobilepay","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-06-10 10:31:44","amount":9900,"currency":"DKK","status":"processing","type":"pay"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"DK2026","partner_id":"123989"}},"key":"MobilePay","summary":"MobilePay","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/MobilePay"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Multibanco":{"value":{"order":{"method":"multibanco","order_id":"order_abc123","created_at":"2026-04-23 10:31:44","updated_at":"2026-04-23 10:31:44","amount":2490,"currency":"EUR","order_description":"Order #abc123","status":"processing","customer_email":"buyer@example.pt","ip_address":"178.12.34.56"},"transactions":[{"method":"multibanco","id":"4a8d40dc-6935-4cd2-bcde-02beab46f46c","created_at":"2026-04-23 10:31:44","amount":2490,"currency":"EUR","status":"processing","type":"pay"},{"method":"multibanco","id":"b7e2c91a-4f63-48d1-a902-1c8d5e6f7a20","created_at":"2026-04-24 09:15:00","amount":500,"currency":"EUR","status":"success","type":"refund"}],"payment_type_data":{"type":"multibanco","entity":"24000","reference":"256309828","reference_expiration":"2026-04-24T10:31:44Z"},"order_metadata":{"coupon_code":"PT2026","partner_id":"123989"}},"key":"Multibanco","summary":"Multibanco","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Multibanco"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/OXXO":{"value":{"order":{"method":"oxxo","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"MXN","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"oxxo","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"MXN","status":"processing","type":"pay"},{"method":"oxxo","id":"another_transaction_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"MXN","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"OXXO","summary":"OXXO","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/OXXO"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Pay by Bank":{"value":{"order":{"method":"openbanking","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"EUR","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","ip_address":"203.0.113.0"},"transactions":[{"method":"openbanking","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"EUR","status":"processing","type":"pay"},{"method":"openbanking","id":"another_transaction_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"EUR","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/transaction/abc123","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Pay by Bank","summary":"Pay by Bank","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Pay by Bank"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Pix QR":{"value":{"order":{"method":"pix-qr","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"BRL","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"pix-qr","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"BRL","status":"processing","type":"pay"},{"method":"pix-qr","id":"another_unique_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"BRL","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"payment_type_data":{"qr_code_value":"00020101021226890014br.gov.bcb.pix2563pix.example.com/qr/v2/....","qr_code_expiration_date":"2025-12-28 13:00:00"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Pix QR","summary":"Pix QR","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Pix QR"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Pix Automático":{"value":{"order":{"method":"pix-automatico","order_id":"order_1234567890","created_at":"2026-04-10 11:36:45","updated_at":"2026-04-10 11:36:46","amount":1000,"currency":"BRL","order_description":"Premium package","status":"processing","customer_account_id":"customer_account_id","customer_email":"example@example.com","customer_first_name":"John","customer_last_name":"Doe","ip_address":"203.0.113.0"},"pay_form":{"return_url":"https://payment-provider.example/return","script_url":""},"transactions":[{"method":"pix-automatico","id":"175f83e6-665d-49f2-b6f0-836690ea7a1b","created_at":"2026-04-10 11:36:45","amount":1000,"currency":"BRL","status":"processing","type":"pay"}],"payment_type_data":{"qr_code_value":"00020101021226780014br.gov.bcb.pix2563pix.example.com/qr/v2/cobv/...","qr_code_expiration_date":"2026-04-10 12:36:45"}},"key":"Pix Automático","summary":"Pix Automático","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Pix Automático"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Przelewy24":{"value":{"order":{"method":"przelewy24","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"PLN","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"przelewy24","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"PLN","status":"processing","type":"pay"},{"method":"przelewy24","id":"another_transaction_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"PLN","status":"success","type":"refund"}],"pay_form":{"return_url":"https://sandbox.przelewy24.pl/trnRequest/example","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Przelewy24","summary":"Przelewy24","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Przelewy24"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/PSE":{"value":{"order":{"method":"pse","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-21 11:21:30","updated_at":"2025-12-21 12:00:00","amount":10000,"currency":"COP","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"pse","id":"unique_transaction_id_1","created_at":"2025-12-21 11:21:30","amount":5000,"currency":"COP","status":"processing","type":"pay"},{"method":"pse","id":"unique_transaction_id_2","created_at":"2025-12-21 11:30:00","amount":5000,"currency":"COP","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"PSE","summary":"PSE","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/PSE"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Sencillito":{"value":{"order":{"method":"sencillito","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-21 11:21:30","updated_at":"2025-12-21 12:00:00","amount":1000,"currency":"CLP","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"sencillito","id":"unique_transaction_id_1","created_at":"2025-12-21 11:21:30","amount":500,"currency":"CLP","status":"processing","type":"pay"},{"method":"sencillito","id":"unique_transaction_id_2","created_at":"2025-12-21 11:30:00","amount":500,"currency":"CLP","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Sencillito","summary":"Sencillito","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Sencillito"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Servipag":{"value":{"order":{"method":"servipag","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-21 11:21:30","updated_at":"2025-12-21 12:00:00","amount":1000,"currency":"CLP","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"servipag","id":"unique_transaction_id_1","created_at":"2025-12-21 11:21:30","amount":500,"currency":"CLP","status":"processing","type":"pay"},{"method":"servipag","id":"unique_transaction_id_2","created_at":"2025-12-21 11:30:00","amount":500,"currency":"CLP","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Servipag","summary":"Servipag","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Servipag"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/SmartPix":{"value":{"order":{"method":"pix","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"BRL","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"pix","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"BRL","status":"processing","type":"pay"},{"method":"pix","id":"another_unique_id","created_at":"2025-12-28 12:00:00","amount":50,"currency":"BRL","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"SmartPix","summary":"SmartPix","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/SmartPix"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/UPI":{"value":{"order":{"method":"upi","order_id":"order_rec_001","created_at":"2026-05-18 10:31:44","updated_at":"2026-05-18 10:31:44","amount":29900,"currency":"INR","order_description":"Monthly subscription","status":"processing","customer_email":"buyer@example.in","ip_address":"103.21.56.78"},"pay_form":{"token":"pftlymnx6gq32ej3dvr9p45w","return_url":"https://merchant.example.com/return","script_url":""},"payment_type_data":{"deep_link_value":"upi://mandate?pa=merchant@upi&pn=MerchantName&tr=pay_KfyQIVi7wcL8Po&tn=Monthly+subscription"},"transactions":[]},"key":"UPI","summary":"UPI","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/UPI"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Webpay":{"value":{"order":{"method":"webpay","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-21 11:21:30","updated_at":"2025-12-21 12:00:00","amount":1000,"currency":"CLP","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0"},"transactions":[{"method":"webpay","id":"unique_transaction_id_1","created_at":"2025-12-21 11:21:30","amount":500,"currency":"CLP","status":"processing","type":"pay"},{"method":"webpay","id":"unique_transaction_id_2","created_at":"2025-12-21 11:30:00","amount":500,"currency":"CLP","status":"success","type":"refund"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Webpay","summary":"Webpay","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Webpay"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/WeChat Pay":{"value":{"order":{"method":"wechatpay","order_id":"order_20251221_CNY_8901","created_at":"2025-10-20 16:17:41","updated_at":"2025-10-20 16:17:42","amount":8900,"currency":"CNY","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","ip_address":"8.8.8.8"},"transactions":[{"method":"wechatpay","id":"4a8d40dc-6935-4cd2-b6f0-836690ea7e1e","created_at":"2025-10-20 16:17:41","amount":8900,"currency":"CNY","status":"processing","type":"pay"},{"method":"wechatpay","id":"b752929e-82b8-5cda-a513-4f8e8e5g1234","created_at":"2025-10-20 17:30:00","amount":600,"currency":"CNY","status":"success","type":"refund"}],"pay_form":{"return_url":"https://simulator-ui-stage.boku.com/redirect/6c1bd3c5-eb17-4c27-be88-b7d0fd849a45","script_url":"https://payment-provider.example/widget/example.js"},"order_metadata":{"coupon_code":"WX2025","partner_id":"123989"}},"key":"WeChat Pay","summary":"WeChat Pay","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/WeChat Pay"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1init-payment/post/responses/200/content/application~1json/examples/Error X.XX":{"value":{"error":{"code":"3.02","messages":["Insufficient funds"],"recommended_message_for_user":"The card balance has insufficient funds."}},"key":"Error X.XX","summary":"Error X.XX","id":"paths/~1init-payment/post/responses/200/content/application~1json/examples/Error X.XX"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/PayPal":{"value":{"payment_method":"paypal-vault","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"PayPal","summary":"PayPal","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/PayPal"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Alipay":{"value":{"payment_method":"alipay","token":"ffb850ff6d134cab887fb1da5550cd758f66","order_id":"order_recur_20251221_CNY_001","amount":8900,"currency":"CNY","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_phone":"+8613812345678","language":"en","ip_address":"8.8.8.8","platform":"WEB","order_metadata":{"coupon_code":"CNY2025","partner_id":"123989"}},"key":"Alipay","summary":"Alipay","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Alipay"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Blik":{"value":{"payment_method":"blik","token":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","order_id":"charge_sub_20240501","amount":2999,"currency":"PLN","order_description":"Monthly Premium Plan - May","customer_email":"customer@example.pl","ip_address":"178.12.34.56","platform":"WEB"},"key":"Blik","summary":"Blik","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Blik"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/GCash":{"value":{"payment_method":"gcash","token":"5hc1041dh9458dhdeee7e13g0e216i22i6dei8gee1g262gi71e73088907hggffhh01317hde8id2f48d662f27i4dg5e63fi522","order_id":"order_recur_20251103_PHP_001","amount":2575,"currency":"PHP","order_description":"Premium package","order_date":"2025-11-03 16:10:00","customer_account_id":"user_id_67890","customer_email":"example.user@example.com","customer_date_of_birth":"1990-05-15","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"subscription_id":"sub_12345","partner_id":"123989"}},"key":"GCash","summary":"GCash","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/GCash"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Klarna":{"value":{"payment_method":"klarna-network","token":"5hc1041dh9458dhdeee7e13g0e216i22i6dei8gee1g262gi71e73088907hggffhh01317hde8id2f48d662f27i4dg5e63fi522","order_id":"order_kln_recur_001","amount":9900,"currency":"EUR","order_description":"Monthly subscription","order_date":"2026-05-19 11:00:00","customer_account_id":"user_id_67890","customer_email":"buyer@example.com","customer_first_name":"Emma","customer_last_name":"Johansson","customer_date_of_birth":"1990-03-15","payment_type_data":{"klarna_network_session_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.klarna_session_token_example","klarna_network_data":"{\"order_lines\":[{\"name\":\"Monthly subscription\",\"quantity\":1,\"unit_price\":9900,\"total_amount\":9900}]}","klarna_originators":[{"name":"SHOPIFY","session_reference":"shop-session-abc123","module_name":"shopify-plugin","module_version":"1.0.0"}]},"language":"en","ip_address":"82.115.34.21","platform":"WEB","order_metadata":{"subscription_id":"sub_12345","partner_id":"123989"},"fail_url":"https://merchant.example/fail"},"key":"Klarna","summary":"Klarna","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Klarna"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/MB WAY":{"value":{"payment_method":"mbway","token":"ffb850ff6d134cab887fb1da5550cd758f66","order_id":"order_recur_20251221_EUR_001","amount":1020,"currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_phone":"+351912345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"EUR2025","partner_id":"123989"}},"key":"MB WAY","summary":"MB WAY","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/MB WAY"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Mercado Pago":{"value":{"payment_method":"mercadopago","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Mercado Pago","summary":"Mercado Pago","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Mercado Pago"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Pix Automático":{"value":{"payment_method":"pix-automatico","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2026-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2026","partner_id":"123989"}},"key":"Pix Automático","summary":"Pix Automático","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Pix Automático"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/SmartPix":{"value":{"payment_method":"pix","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"SmartPix","summary":"SmartPix","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/SmartPix"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/UPI":{"value":{"payment_method":"upi","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"INR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"UPI","summary":"UPI","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/UPI"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/WeChat Pay":{"value":{"payment_method":"wechatpay","token":"12e07128df5f4f5faaddaacc89765432","order_id":"order_recur_20251221_CNY_002","amount":8900,"currency":"CNY","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_phone":"+8613812345678","language":"en","ip_address":"8.8.8.8","order_metadata":{"coupon_code":"WX2025","partner_id":"123989"}},"key":"WeChat Pay","summary":"WeChat Pay","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/WeChat Pay"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment PayPal":{"value":{"payment_method":"paypal-vault","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"u4v5w6x7-8y9z-01a2-b3c4-567de890fg12","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"EUR","order_description":"Exclusive package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}},"key":"Product-based payment PayPal","summary":"Product-based payment PayPal","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment PayPal"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Alipay":{"value":{"payment_method":"alipay","token":"2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"order_prod_recur_20251221_CNY_001","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"CNY","order_description":"Exclusive package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_date_of_birth":"1988-11-21","customer_phone":"+8613812345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}},"key":"Product-based payment Alipay","summary":"Product-based payment Alipay","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Alipay"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Blik":{"value":{"payment_method":"blik","token":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","order_id":"charge_sub_product_20240501","product_id":"b2c3d4e5-f6a7-4890-b123-456789abcdef","currency":"PLN","order_description":"Monthly Premium Plan - May","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"customer@example.pl","ip_address":"178.12.34.56","platform":"WEB"},"key":"Product-based payment Blik","summary":"Product-based payment Blik","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Blik"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment GCash":{"value":{"payment_method":"gcash","token":"2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"order_prod_recur_20251103_PHP_001","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"PHP","order_description":"Exclusive package","order_date":"2025-11-03 15:51:00","customer_account_id":"user_id_67890","customer_email":"example.user@example.com","customer_date_of_birth":"1990-05-15","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}},"key":"Product-based payment GCash","summary":"Product-based payment GCash","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment GCash"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment MB WAY":{"value":{"payment_method":"mbway","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"order_recur_otp_20251221_EUR_001","product_id":"b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8","currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","customer_phone":"+351912345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"EUR2025","partner_id":"123989"}},"key":"Product-based payment MB WAY","summary":"Product-based payment MB WAY","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment MB WAY"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago":{"value":{"payment_method":"mercadopago","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"u4v5w6x7-8y9z-01a2-b3c4-567de890fg12","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"BRL","order_description":"Exclusive package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}},"key":"Product-based payment Mercado Pago","summary":"Product-based payment Mercado Pago","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Mercado Pago"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment UPI":{"value":{"payment_method":"upi","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"u4v5w6x7-8y9z-01a2-b3c4-567de890fg12","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"INR","order_description":"Exclusive package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}},"key":"Product-based payment UPI","summary":"Product-based payment UPI","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment UPI"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Pix Automático":{"value":{"payment_method":"pix-automatico","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2026-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}},"key":"Product-based payment Pix Automático","summary":"Product-based recurring Pix Automático","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment Pix Automático"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment SmartPix":{"value":{"payment_method":"pix","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}},"key":"Product-based payment SmartPix","summary":"Product-based recurring SmartPix","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment SmartPix"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay":{"value":{"payment_method":"wechatpay","token":"3fa0829bf7236bfbcc5c91e8c094g00g4bcg6ecc9e040eg59c51866785feeddff89195fbc6gb0d26b440d05g2be3c41dg300","order_id":"order_prod_recur_20251221_CNY_002","product_id":"v5w6x7y8-z901-a2b3-c456-de789fg012hi","currency":"CNY","order_description":"Exclusive package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_date_of_birth":"1988-11-21","customer_phone":"+8613812345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"partner_id":"123989"}},"key":"Product-based payment WeChat Pay","summary":"Product-based payment WeChat Pay","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Product-based payment WeChat Pay"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment PayPal":{"value":{"payment_method":"paypal-vault","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Subscription payment PayPal","summary":"Subscription payment PayPal","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment PayPal"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Alipay":{"value":{"payment_method":"alipay","token":"2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"order_sub_20251221_CNY_001","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"CNY","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_date_of_birth":"1988-11-21","customer_phone":"+8613812345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Subscription payment Alipay","summary":"Subscription payment Alipay","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Alipay"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Blik":{"value":{"payment_method":"blik","token":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","order_id":"charge_sub_product_20240501","product_id":"b2c3d4e5-f6a7-4890-b123-456789abcdef","currency":"PLN","order_description":"Monthly Premium Plan - May","customer_account_id":"93a1c659-288d-4d72-929d-10e241078faa","customer_email":"customer@example.pl","ip_address":"178.12.34.56","platform":"WEB"},"key":"Subscription payment Blik","summary":"Subscription payment Blik","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Blik"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment GCash":{"value":{"payment_method":"gcash","token":"2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"order_sub_20251103_PHP_001","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"PHP","order_description":"Premium package","order_date":"2025-11-03 15:51:00","customer_account_id":"user_id_67890","customer_email":"example.user@example.com","customer_date_of_birth":"1990-05-15","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"PH2025","partner_id":"123989"}},"key":"Subscription payment GCash","summary":"Subscription payment GCash","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment GCash"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment MB WAY":{"value":{"payment_method":"mbway","token":"2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"order_sub_recur_20251221_EUR_001","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"EUR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","customer_phone":"+351912345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"EUR2025","partner_id":"123989"}},"key":"Subscription payment MB WAY","summary":"Subscription payment MB WAY","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment MB WAY"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago":{"value":{"payment_method":"mercadopago","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Subscription payment Mercado Pago","summary":"Subscription payment Mercado Pago","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Mercado Pago"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático":{"value":{"payment_method":"pix-automatico","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2026-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2026","partner_id":"123989"}},"key":"Subscription payment Pix Automático","summary":"Subscription Pix Automático","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment Pix Automático"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment SmartPix":{"value":{"payment_method":"pix","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"BRL","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Subscription payment SmartPix","summary":"Subscription SmartPix","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment SmartPix"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment UPI":{"value":{"payment_method":"upi","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"INR","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Alejandro","customer_last_name":"Gomez","customer_date_of_birth":"1988-11-21","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Subscription payment UPI","summary":"Subscription payment UPI","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment UPI"},"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay":{"value":{"payment_method":"wechatpay","token":"3fa0829bf7236bfbcc5c91e8c094g00g4bcg6ecc9e040eg59c51866785feeddff89195fbc6gb0d26b440d05g2be3c41dg300","order_id":"order_sub_20251221_CNY_002","product_id":"ac43b415-5522-4373-b026-a365462f9657","currency":"CNY","order_description":"Premium package","order_date":"2025-12-21 11:21:30","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"test@merchant.example","customer_date_of_birth":"1988-11-21","customer_phone":"+8613812345678","language":"en","ip_address":"203.0.113.0","platform":"WEB","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Subscription payment WeChat Pay","summary":"Subscription payment WeChat Pay","id":"paths/~1v1~1recurring/post/requestBody/content/application~1json/examples/Subscription payment WeChat Pay"},"paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Success":{"value":{"order":{"method":"paypal-vault","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"USD","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"ip_address":"203.0.113.0","provider_data":{"billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"payer":{"first_name":"John","last_name":"Doe","email":"example@example.com"},"merchant":{"account_id":"78UQ777KUJAQN"}},"transactions":[{"method":"paypal-vault","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"USD","status":"processing","type":"pay","refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"payment_type_data":{"amount":107.51,"currency":"BRL","expiration_date":"2025-06-04","image_url":"https://payment-provider.example/transaction/abc123","number":"3419109107005633044159101318002","type":"CUSTOM"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Success","summary":"Success","id":"paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Success"},"paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error X.XX":{"value":{"error":{"code":"3.02","messages":["Insufficient funds"],"recommended_message_for_user":"The card balance has insufficient funds."}},"key":"Error X.XX","summary":"Error X.XX","id":"paths/~1v1~1recurring/post/responses/200/content/application~1json/examples/Error X.XX"},"paths/~1v1~1recurring-token~1cancel/post/requestBody/content/application~1json/examples/Request":{"value":{"token":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55"},"key":"Request","summary":"Request","id":"paths/~1v1~1recurring-token~1cancel/post/requestBody/content/application~1json/examples/Request"},"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Success":{"value":{"status":"processing"},"key":"Success","summary":"Success","id":"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Success"},"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 1.01 Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Error 1.01 Authentication failed","summary":"Error 1.01 Authentication failed","id":"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 1.01 Authentication failed"},"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Token not found":{"value":{"error":{"code":"2.01","messages":{"general":["recurring token was not found"]}}},"key":"Error 2.01 Token not found","summary":"Error 2.01 Token not found","id":"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Token not found"},"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Unsupported method":{"value":{"error":{"code":"2.01","messages":{"general":["recurring token payment method is bizum, but should be one of the following: alipay, mbway, wechatpay"]}}},"key":"Error 2.01 Unsupported method","summary":"Error 2.01 Unsupported method","id":"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Unsupported method"},"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Token already cancelled":{"value":{"error":{"code":"2.01","messages":{"general":["recurring token is already cancelled"]}}},"key":"Error 2.01 Token already cancelled","summary":"Error 2.01 Token already cancelled","id":"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Token already cancelled"},"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation already processing":{"value":{"error":{"code":"2.01","messages":{"general":["recurring token cancellation is already processing"]}}},"key":"Error 2.01 Cancellation already processing","summary":"Error 2.01 Cancellation already processing","id":"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation already processing"},"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation is already concurrently processing":{"value":{"error":{"code":"2.01","messages":{"general":["recurring token cancellation is already concurrently processing"]}}},"key":"Error 2.01 Cancellation is already concurrently processing","summary":"Error 2.01 Cancellation is already concurrently processing","id":"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation is already concurrently processing"},"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation failed":{"value":{"error":{"code":"2.01","messages":{"general":["recurring token cancellation has failed"]}}},"key":"Error 2.01 Cancellation failed","summary":"Error 2.01 Cancellation failed","id":"paths/~1v1~1recurring-token~1cancel/post/responses/200/content/application~1json/examples/Error 2.01 Cancellation failed"},"paths/~1v1~1refund/post/requestBody/content/application~1json/examples/Refund":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"refund_reason_code":"0022"},"key":"Refund","summary":"Refund","id":"paths/~1v1~1refund/post/requestBody/content/application~1json/examples/Refund"},"paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Success":{"value":{"order":{"method":"paypal-vault","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"USD","order_description":"Premium package","status":"processing","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"ip_address":"203.0.113.0","provider_data":{"billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"payer":{"first_name":"John","last_name":"Doe","email":"example@example.com"},"merchant":{"account_id":"78UQ777KUJAQN"}},"transactions":[{"method":"paypal-vault","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"USD","status":"processing","type":"pay","refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"payment_type_data":{"amount":107.51,"currency":"BRL","expiration_date":"2025-06-04","image_url":"https://payment-provider.example/transaction/abc123","number":"3419109107005633044159101318002","type":"CUSTOM"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Success","summary":"Success","id":"paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Success"},"paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1v1~1refund/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1v1~1status/post/responses/200/content/application~1json/examples/Success":{"value":{"order":{"method":"paypal-vault","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":1020,"currency":"USD","status":"processing","order_description":"Premium package","descriptor":"PAYPAL *MERCH TOPSELL","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0","provider_data":{"billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"payer":{"account_id":"Z5WEEM3YYCXBB","first_name":"John","last_name":"Doe","email":"example@example.com","phone":"+352111222333"},"merchant":{"account_id":"78UQ777KUJAQN"}}},"error":{"code":"5.02","messages":["Invalid Card Token"],"recommended_message_for_user":"Invalid Card Token"},"transactions":[{"method":"paypal-vault","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"USD","status":"processing","type":"pay","refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022"}],"pay_form":{"return_url":"https://payment-provider.example/return","script_url":"https://payment-provider.example/widget/example.js"},"payment_type_data":{"amount":107.51,"currency":"BRL","expiration_date":"2025-06-04","image_url":"https://payment-provider.example/transaction/abc123","number":"3419109107005633044159101318002","type":"CUSTOM"},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Success","summary":"Success","id":"paths/~1v1~1status/post/responses/200/content/application~1json/examples/Success"},"paths/~1v1~1status/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1v1~1status/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1v1~1status/post/responses/200/content/application~1json/examples/Error 2.01 Order not found":{"value":{"error":{"code":"2.01","messages":{"order":["Order not found."]}}},"key":"Error 2.01 Order not found","summary":"Error 2.01 Order not found","id":"paths/~1v1~1status/post/responses/200/content/application~1json/examples/Error 2.01 Order not found"},"paths/~1v1~1status/post/responses/200/content/application~1json/examples/Error X.XX":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error X.XX","summary":"Error X.XX","id":"paths/~1v1~1status/post/responses/200/content/application~1json/examples/Error X.XX"},"paths/APMOrderStatus/post/requestBody/content/application~1json/examples/Updated alternative order":{"value":{"order":{"method":"paypal-vault","order_id":"dce52ec4-2ee3-45f8-8333-cfbb7ac2ee49","subscription_id":"83b19018-cbc4-4df0-899a-dda84fd2705e","token":"baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"currency":"USD","order_description":"Premium package","descriptor":"PAYPAL *MERCH TOPSELL","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","status":"processing","ip_address":"203.0.113.0","provider_data":{"billing_address":{"country":"USA","state":"WA","city":"New York","zip":"10005","line1":"123 Main St.","line2":"Apt. 123"},"shipping_address":{"country":"USA","state":"NY","city":"Boston","zip":"91191","line1":"777 Main St.","line2":"Apt. 321"},"payer":{"account_id":"Z5WEEM3YYCXBB","first_name":"John","last_name":"Doe","email":"example@example.com","phone":"+352111222333"},"merchant":{"account_id":"78UQ777KUJAQN"}}},"error":{"code":"5.02","messages":["Invalid Card Token"],"recommended_message_for_user":"Invalid Card Token"},"transactions":[{"method":"paypal-vault","id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2025-12-27 11:45:30","amount":100,"currency":"USD","status":"processing","type":"pay","refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022"}],"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}},"key":"Updated alternative order","summary":"Updated alternative order","id":"paths/APMOrderStatus/post/requestBody/content/application~1json/examples/Updated alternative order"},"paths/PayPalDispute/post/requestBody/content/application~1json/examples/Received PayPal dispute":{"value":{"dispute_id":"PP-D-85112454","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","subscription_product_id":"ac43b415-5522-4373-b026-a365462f9657","subscription_service_id":"fb603790-1234-1111-9876-ae4d59d5d378","created_at":"2025-08-23 12:05:28","updated_at":"2025-08-23 12:05:28","seller_response_due_date":"2025-09-14 16:29:12","dispute_amount":100,"dispute_currency":"USD","dispute_life_cycle_stage":"CHARGEBACK","dispute_channel":"INTERNAL","dispute_create_time":"2025-07-02 23:39:06","dispute_update_time":"2025-07-08 1:40:44","dispute_outcome":"RESOLVED_WITH_PAYOUT","reason":"MERCHANDISE_OR_SERVICE_NOT_RECEIVED","status":"WAITING_FOR_SELLER_RESPONSE","represented_by":"merchant","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","available_actions":["enrich_evidence","provide_evidence"]},"key":"Received PayPal dispute","summary":"Received PayPal dispute","id":"paths/PayPalDispute/post/requestBody/content/application~1json/examples/Received PayPal dispute"},"paths/APMPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert":{"value":{"order":{"id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-12-27 11:45:30","amount":100,"currency":"USD","status":"approved"},"alert":{"id":"83b19018-cbc4-4df0-899a-dda84fd2705e","amount":200,"currency":"EUR","provider_name":"ethoca","alert_date":"2025-12-29 11:01:03","created_at":"2025-12-29 11:03:30","updated_at":"2025-12-29 11:03:31","alert_type":"inquiry","outcome":"reversed"}},"key":"Received prevention alert","summary":"Received prevention alert","id":"paths/APMPreventAlert/post/requestBody/content/application~1json/examples/Received prevention alert"},"paths/APMRevokedRecurringToken/post/requestBody/content/application~1json/examples/Revoked recurring token":{"value":{"token":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","initial_order_id":"22738n","cancelled_at":"2024-12-21 11:21:30"},"key":"Revoked recurring token","summary":"Revoked recurring token","id":"paths/APMRevokedRecurringToken/post/requestBody/content/application~1json/examples/Revoked recurring token"},"paths/~1products/post/requestBody/content/application~1json/examples/Product-based payment":{"value":{"name":"Luxury product","type":"one-time","description":"This product is the best product all over the world","public_description":"That cool product which you have bought","status":"active","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}},"key":"Product-based payment","summary":"Product-based payment","id":"paths/~1products/post/requestBody/content/application~1json/examples/Product-based payment"},"paths/~1products/post/requestBody/content/application~1json/examples/Subscription payment":{"value":{"name":"Luxury product","type":"recurring","description":"This product is the best product all over the world","public_description":"That cool product which you have bought","status":"active","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1products/post/requestBody/content/application~1json/examples/Subscription payment"},"paths/~1products/post/responses/200/content/application~1json/examples/Product-based payment":{"value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"one-time","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}},"key":"Product-based payment","summary":"Product-based payment","id":"paths/~1products/post/responses/200/content/application~1json/examples/Product-based payment"},"paths/~1products/post/responses/200/content/application~1json/examples/Subscription payment":{"value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"recurring","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1products/post/responses/200/content/application~1json/examples/Subscription payment"},"paths/~1products/get/responses/200/content/application~1json/examples/Product-based payment":{"value":{"data":[{"id":"cb43b415-5522-4373-b026-a365462f9114","name":"Luxury product","type":"one-time","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}],"pagination":{"offset":20,"limit":10,"total_count":150}},"key":"Product-based payment","summary":"Product-based payment","id":"paths/~1products/get/responses/200/content/application~1json/examples/Product-based payment"},"paths/~1products/get/responses/200/content/application~1json/examples/Subscription payment":{"value":{"data":[{"id":"cb43b415-5522-4373-b026-a365462f9114","name":"Luxury product","type":"recurring","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}}],"pagination":{"offset":20,"limit":10,"total_count":150}},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1products/get/responses/200/content/application~1json/examples/Subscription payment"},"paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Product-based payment":{"value":{"name":"Luxury product","description":"This product is the best product all over the world","public_description":"That cool product which you have bought","status":"active","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}},"key":"Product-based payment","summary":"Product-based payment","id":"paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Product-based payment"},"paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Subscription payment":{"value":{"name":"Luxury product","description":"This product is the best product all over the world","public_description":"That cool product which you have bought","status":"active","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1products~1{product_id}/patch/requestBody/content/application~1json/examples/Subscription payment"},"paths/~1products~1{product_id}/patch/responses/200/content/application~1json/examples/Product-based payment":{"value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"one-time","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}},"key":"Product-based payment","summary":"Product-based payment","id":"paths/~1products~1{product_id}/patch/responses/200/content/application~1json/examples/Product-based payment"},"paths/~1products~1{product_id}/patch/responses/200/content/application~1json/examples/Subscription payment":{"value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"recurring","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1products~1{product_id}/patch/responses/200/content/application~1json/examples/Subscription payment"},"paths/~1products~1{product_id}/get/responses/200/content/application~1json/examples/Product-based payment":{"value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"one-time","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}},"key":"Product-based payment","summary":"Product-based payment","id":"paths/~1products~1{product_id}/get/responses/200/content/application~1json/examples/Product-based payment"},"paths/~1products~1{product_id}/get/responses/200/content/application~1json/examples/Subscription payment":{"value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"recurring","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"active","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1products~1{product_id}/get/responses/200/content/application~1json/examples/Subscription payment"},"paths/~1products~1{product_id}~1archive/post/responses/200/content/application~1json/examples/Product-based payment":{"value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"one-time","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"archived","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","payment_action":"auth_settle","settle_interval":48,"tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}},"key":"Product-based payment","summary":"Product-based payment","id":"paths/~1products~1{product_id}~1archive/post/responses/200/content/application~1json/examples/Product-based payment"},"paths/~1products~1{product_id}~1archive/post/responses/200/content/application~1json/examples/Subscription payment":{"value":{"id":"ac43b415-5522-4373-b026-a365462f9657","name":"Luxury product","type":"recurring","description":"This product is the best product all over the world","public_description":"That cool product that you have bought","status":"archived","created_at":"2025-05-31 12:53:12","updated_at":"2025-05-31 12:53:13","term_length":20,"payment_action":"auth_settle","settle_interval":48,"billing_period":{"unit":"day","value":10},"trial":{"billing_period":{"unit":"day","value":10},"payment_action":"auth_settle","settle_interval":48},"retry_mode":"static","retry_strategy_id":"db43b415-5522-4373-b026-a365462f9439","tax":{"category_id":"taxc_01JJVD231C879QBHVTVCWJ1K2A","behavior":"included"},"metadata":{"access_duration":"30d","plan_tier":"premium"}},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1products~1{product_id}~1archive/post/responses/200/content/application~1json/examples/Subscription payment"},"paths/~1products~1calculatePrice/post/responses/200/content/application~1json/examples/Success":{"value":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","currency":"USD","total_amount":100,"tax":{"tax_amount":20,"taxable_amount":80,"location":"USA","profile_id":"taxp_01JJVD231C879QBHVTVCWJ1K2A","rate_id":"taxr_01JJVD231C879QBHVTVCWJ1K2A","rate":25,"is_included":true},"recurring":{"total_amount":100,"tax":{"tax_amount":20,"taxable_amount":80,"location":"USA","rate":25,"is_included":true}}},"key":"Success","summary":"Success","id":"paths/~1products~1calculatePrice/post/responses/200/content/application~1json/examples/Success"},"paths/~1transactional/post/responses/200/content/application~1json/examples/Success":{"value":{"report_url":"https://reports.solidgate.com/api/v1/tax/transactional/report/tax_transactional_250702_140728/download"},"key":"Success","summary":"Success","id":"paths/~1transactional/post/responses/200/content/application~1json/examples/Success"},"paths/~1transactional/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1transactional/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success":{"value":{"report_url":"https://reports.solidgate.com/api/v1/tax/transactional/report/TAX_250702_140728_CHECKOUT/download"},"key":"Success","summary":"Success","id":"paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success"},"paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Invalid data","summary":"Invalid data","id":"paths/~1transactional~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"},"paths/~1summary/post/responses/200/content/application~1json/examples/Success":{"value":{"report_url":"https://reports.solidgate.com/api/v1/tax/summary/report/tax_summary_250702_140728/download"},"key":"Success","summary":"Success","id":"paths/~1summary/post/responses/200/content/application~1json/examples/Success"},"paths/~1summary/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1summary/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success":{"value":{"report_url":"https://reports.solidgate.com/api/v1/tax/summary/report/TAX_250702_140728_CHECKOUT/download"},"key":"Success","summary":"Success","id":"paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success"},"paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Invalid data","summary":"Invalid data","id":"paths/~1summary~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"},"paths/CalculatedTax/post/requestBody/content/application~1json/examples/Calculated tax":{"value":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"1538344f-9e1a-4ad0-9a1e-7e6e4669775a","total_amount":1000,"currency":"USD","action":"sale","payment_category":"card-payment","transaction_date":"2025-12-06 15:18:40","tax_included":true,"tax":{"tax_amount":91,"taxable_amount":909,"rate":10,"currency":"USD","location":{"country":"USA","state":"MD"},"legal_entity":"Tech Solutions"}},"key":"Calculated tax","summary":"Calculated tax","id":"paths/CalculatedTax/post/requestBody/content/application~1json/examples/Calculated tax"},"paths/~1subscription~1update-token/post/responses/404/content/application~1json/examples/Entity not found":{"value":{"error":{"code":"2.01","message":"{entityName} not found"}},"key":"Entity not found","summary":"Entity not found","id":"paths/~1subscription~1update-token/post/responses/404/content/application~1json/examples/Entity not found"},"paths/Billing/post/requestBody/content/application~1json/examples/extended create":{"value":{"callback_type":"create","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"pending","updated_at":"2025-09-08 12:37:25","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"processing","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"processing","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended create","summary":"extended create","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended create"},"paths/Billing/post/requestBody/content/application~1json/examples/extended expire":{"value":{"callback_type":"expire","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"expired","updated_at":"2025-09-08 12:37:25","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"fail","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"auth_failed","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended expire","summary":"extended expire","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended expire"},"paths/Billing/post/requestBody/content/application~1json/examples/extended payment_attempt":{"value":{"callback_type":"payment_attempt","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"pending","updated_at":"2025-09-28 11:45:25","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:10","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-09-27 11:45:30","billing_period_ended_at":"2025-09-28 11:45:40","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"auth_ok","created_at":"2025-09-27 11:45:25","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:25","amount":100,"discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended payment_attempt","summary":"extended payment_attempt","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended payment_attempt"},"paths/Billing/post/requestBody/content/application~1json/examples/extended active":{"value":{"callback_type":"active","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"approved","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended active","summary":"extended active","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended active"},"paths/Billing/post/requestBody/content/application~1json/examples/extended renew":{"value":{"callback_type":"renew","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"auth_ok","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended renew","summary":"extended renew","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended renew"},"paths/Billing/post/requestBody/content/application~1json/examples/extended switch_product":{"value":{"callback_type":"switch_product","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-10-01 15:30:00","expired_at":"2025-10-08 12:37:24","next_charge_at":"2025-11-08 12:37:24","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"b62cba1d-4e8f-42f9-a9d1-cef09831f7ae","name":"Premium Audiobook Collection","amount":150,"currency":"USD","trial":false},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-10-01 15:30:00","updated_at":"2025-10-01 15:31:00","amount":150,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-10-08 12:37:24","billing_period_ended_at":"2025-11-08 12:37:24","subscription_term_number":2,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-10-01 15:30:00","updated_at":"2025-10-01 15:30:00","processed_at":"2025-10-01 15:31:00","amount":150,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-10-02 15:30:00","updated_at":"2025-10-02 15:30:00","processed_at":"2025-10-02 15:31:00","amount":150,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended switch_product","summary":"extended switch_product","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended switch_product"},"paths/Billing/post/requestBody/content/application~1json/examples/extended order_update":{"value":{"callback_type":"order_update","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-08-26 11:43:52","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"auth_ok","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended order_update","summary":"extended order_update","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended order_update"},"paths/Billing/post/requestBody/content/application~1json/examples/extended pause":{"value":{"callback_type":"pause","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"paused","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-28 07:48:15","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false,"pause":{"from_date":"2025-09-11 11:26:08","to_date":"2025-09-27 11:26:08"}},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended pause","summary":"extended pause","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended pause"},"paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.create":{"value":{"callback_type":"pause_schedule.create","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-24 07:48:15","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false,"pause":{"from_date":"2025-09-11 11:26:08","to_date":"2025-09-27 11:26:08"}},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"auth_ok","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended pause_schedule.create","summary":"extended pause_schedule.create","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.create"},"paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.update":{"value":{"callback_type":"pause_schedule.update","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-28 11:48:15","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":true,"pause":{"from_date":"2025-09-11 11:26:08","to_date":"2025-09-27 11:26:08"}},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended pause_schedule.update","summary":"extended pause_schedule.update","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.update"},"paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.delete":{"value":{"callback_type":"pause_schedule.delete","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"auth_ok","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended pause_schedule.delete","summary":"extended pause_schedule.delete","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended pause_schedule.delete"},"paths/Billing/post/requestBody/content/application~1json/examples/extended resume":{"value":{"callback_type":"resume","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"auth_ok","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended resume","summary":"extended resume","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended resume"},"paths/Billing/post/requestBody/content/application~1json/examples/extended recurring":{"value":{"callback_type":"recurring","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"approved","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended recurring","summary":"extended recurring","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended recurring"},"paths/Billing/post/requestBody/content/application~1json/examples/extended restore":{"value":{"callback_type":"restore","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"auth_ok","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended restore","summary":"extended restore","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended restore"},"paths/Billing/post/requestBody/content/application~1json/examples/extended cancel":{"value":{"callback_type":"cancel","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"cancelled","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false,"cancelled_at":"2025-09-12 19:37:24","cancellation_requested_at":"2025-09-11 19:37:24","cancel_code":"8.09","cancel_message":"Cancellation after redemption period"},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"fail","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended cancel","summary":"extended cancel","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended cancel"},"paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_cancellation":{"value":{"callback_type":"scheduled_for_cancellation","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","payment_type":"upi","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false,"cancelled_at":"2025-09-12 19:37:24","cancellation_requested_at":"2025-09-11 19:37:24","cancel_code":"8.09","cancel_message":"Cancellation after redemption period"},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"billing_period_started_at":"2025-09-29 11:45:30","billing_period_ended_at":"2025-09-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"auth_ok","created_at":"2025-09-28 11:50:30","updated_at":"2025-09-28 11:50:30","processed_at":"2025-09-29 11:50:30","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended scheduled_for_cancellation","summary":"extended scheduled_for_cancellation","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_cancellation"},"paths/Billing/post/requestBody/content/application~1json/examples/extended redemption":{"value":{"callback_type":"redemption","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"redemption","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-10-08 11:43:52","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"retry","created_at":"2025-09-08 11:45:25","updated_at":"2025-09-08 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-08 11:45:25","updated_at":"2025-09-08 11:45:25","processed_at":"2025-09-08 11:45:30","amount":1000,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended redemption","summary":"extended redemption","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended redemption"},"paths/Billing/post/requestBody/content/application~1json/examples/extended retry":{"value":{"callback_type":"retry","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"redemption","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","payment_type":"card","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"retry","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","processed_at":"2025-09-27 07:55:41","amount":1000,"failed_reason":"3.02","retry_attempt":1},"1772066481453AlexKhy":{"id":"1772066481453AlexKhy","status":"processing","created_at":"2025-09-27 11:45:30","updated_at":"2025-09-27 11:45:30","amount":1000,"retry_attempt":2}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended retry","summary":"extended retry","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended retry"},"paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_retry":{"value":{"callback_type":"scheduled_for_retry","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"redemption","started_at":"2025-09-08 12:37:24","updated_at":"2025-09-08 12:37:25","expired_at":"2025-09-12 12:37:24","next_charge_at":"2025-09-12 12:37:24","payment_type":"paypal-vault","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"retry","created_at":"2025-09-08 12:45:30","updated_at":"2025-09-08 12:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-09-08 12:45:30","updated_at":"2025-09-08 12:45:30","processed_at":"2025-09-08 12:45:41","amount":1000,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1772066481453AlexKhy":{"id":"1772066481453AlexKhy","status":"declined","created_at":"2025-09-10 11:45:30","updated_at":"2025-09-10 11:45:30","processed_at":"2025-09-10 12:45:41","amount":1000,"failed_reason":"3.02","retry_attempt":2,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"extended scheduled_for_retry","summary":"extended scheduled_for_retry","id":"paths/Billing/post/requestBody/content/application~1json/examples/extended scheduled_for_retry"},"paths/Billing/post/requestBody/content/application~1json/examples/init":{"value":{"callback_type":"init","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-11-26 11:43:52","payment_type":"paypal-vault","trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"approved","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"init","summary":"init","id":"paths/Billing/post/requestBody/content/application~1json/examples/init"},"paths/Billing/post/requestBody/content/application~1json/examples/renew":{"value":{"callback_type":"renew","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-12-12 12:37:24","payment_type":"card","trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"auth_ok","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"renew","summary":"renew","id":"paths/Billing/post/requestBody/content/application~1json/examples/renew"},"paths/Billing/post/requestBody/content/application~1json/examples/update":{"value":{"callback_type":"update","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"cancelled","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-11-26 11:43:52","payment_type":"paypal-vault","trial":false,"cancelled_at":"2025-12-12 12:37:20","cancellation_requested_at":"2025-12-12 12:37:20","cancel_code":"8.09","cancel_message":"Cancellation after redemption period"},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"approved","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"update","summary":"update","id":"paths/Billing/post/requestBody/content/application~1json/examples/update"},"paths/Billing/post/requestBody/content/application~1json/examples/cancel":{"value":{"callback_type":"cancel","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"cancelled","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","payment_type":"card","trial":false,"cancelled_at":"2025-12-12 19:37:24","cancellation_requested_at":"2025-12-11 19:37:24","cancel_code":"8.09","cancel_message":"Cancellation after redemption period"},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"fail","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"cancel","summary":"cancel","id":"paths/Billing/post/requestBody/content/application~1json/examples/cancel"},"paths/Billing/post/requestBody/content/application~1json/examples/pause":{"value":{"callback_type":"pause","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"paused","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-12-28 07:48:15","payment_type":"paypal-vault","trial":false,"pause":{"from_date":"2025-12-11 11:26:08","to_date":"2025-12-27 11:26:08"}},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-12-28 11:50:30","updated_at":"2025-12-28 11:50:30","processed_at":"2025-12-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"pause","summary":"pause","id":"paths/Billing/post/requestBody/content/application~1json/examples/pause"},"paths/Billing/post/requestBody/content/application~1json/examples/resume":{"value":{"callback_type":"resume","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-12-12 12:37:24","payment_type":"card","trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-12-28 11:50:30","updated_at":"2025-12-28 11:50:30","processed_at":"2025-12-28 11:50:35","amount":100,"retry_attempt":1}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"resume","summary":"resume","id":"paths/Billing/post/requestBody/content/application~1json/examples/resume"},"paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.create":{"value":{"callback_type":"pause_schedule.create","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","payment_type":"paypal-vault","trial":false,"pause":{"from_date":"2025-12-11 11:26:08","to_date":"2025-12-27 11:26:08"}},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-12-28 11:50:30","updated_at":"2025-12-28 11:50:30","processed_at":"2025-12-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"pause_schedule.create","summary":"pause_schedule.create","id":"paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.create"},"paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.update":{"value":{"callback_type":"pause_schedule.update","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"paused","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-12-28 11:48:15","payment_type":"paypal-vault","trial":false,"pause":{"from_date":"2025-12-11 11:26:08","to_date":"2025-12-27 11:26:08"}},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-12-28 11:50:30","updated_at":"2025-12-28 11:50:30","processed_at":"2025-12-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"pause_schedule.update","summary":"pause_schedule.update","id":"paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.update"},"paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.delete":{"value":{"callback_type":"pause_schedule.delete","subscription":{"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-12-12 12:37:24","payment_type":"paypal-vault","trial":false},"product":{"product_id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1440,"trial_amount":99,"trial_currency":"USD"},"customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"invoices":{"4022a203-ace8-415f-9ae7-730014fceb25":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"success","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"product_price_id":"61b7f690-242a-498c-99a1-eb191f93f08c","billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"1672066481283AlexKho":{"id":"1672066481283AlexKho","status":"declined","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","amount":100,"failed_reason":"3.02","retry_attempt":1,"payment_details":{"invoice_id":"123443334","payer_email":"example@example.com"}},"1692066491293AlexKho":{"id":"1692066491293AlexKho","status":"approved","created_at":"2025-12-28 11:50:30","updated_at":"2025-12-28 11:50:30","processed_at":"2025-12-29 11:50:30","amount":100,"retry_attempt":1,"payment_details":{"invoice_id":"123443340","payer_email":"example@example.com"}}},"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}}},"key":"pause_schedule.delete","summary":"pause_schedule.delete","id":"paths/Billing/post/requestBody/content/application~1json/examples/pause_schedule.delete"},"paths/~1fraud-prevention-list-items~1create/post/requestBody/content/application~1json/examples/Batch":{"value":{"items":[{"list_type":"pass","payment_field":"card_id","field_value":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","expired_at":"2025-12-21 11:21:30","description":"This is a pass rule","created_by":"email@email.com"},{"list_type":"reject","payment_field":"ip_address","field_value":"123.123.123.123","description":"This is a reject rule"}]},"key":"Batch","summary":"Batch","id":"paths/~1fraud-prevention-list-items~1create/post/requestBody/content/application~1json/examples/Batch"},"paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Success":{"value":{"items":[{"id":"1234567","list_type":"pass","payment_field":"card_id","field_value":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-08-20 11:21:30","expired_at":"2025-12-21 11:21:30","description":"This is a pass rule","created_by":"email@email.com"},{"id":"1234568","list_type":"reject","payment_field":"ip_address","field_value":"123.123.123.123","created_at":"2025-09-20 11:21:30","expired_at":null,"description":"This is a reject rule"}]},"key":"Success","summary":"Success","id":"paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Success"},"paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled":{"value":{"error":{"code":"2.01","messages":["Fraud prevention is not enabled"]}},"key":"Error 2.01 Fraud prevention is not enabled","summary":"Error 2.01 Fraud prevention is not enabled","id":"paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled"},"paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Some fraud prevention list items are duplicated":{"value":{"error":{"code":"2.01","messages":["Some fraud prevention list items are duplicated"]}},"key":"Error 2.01 Some fraud prevention list items are duplicated","summary":"Error 2.01 Some fraud prevention list items are duplicated","id":"paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Some fraud prevention list items are duplicated"},"paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1fraud-prevention-list-items~1create/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1fraud-prevention-list-items~1list/post/requestBody/content/application~1json/examples/Batch":{"value":{"list_type":"pass","payment_field_value":{"payment_field":"customer_email","field_value":"test@test.com"},"limit":2000,"include_deleted":true,"created_at_from":"2025-08-15 11:00:00","created_at_to":"2025-08-18 11:00:00","next_page_iterator":"1234567"},"key":"Batch","summary":"Batch","id":"paths/~1fraud-prevention-list-items~1list/post/requestBody/content/application~1json/examples/Batch"},"paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Success":{"value":{"items":[{"id":"1234567","list_type":"pass","payment_field":"customer_email","field_value":"test@test.com","created_at":"2025-08-20 11:21:30","expired_at":"2025-12-21 11:21:30","deleted_at":"2025-08-27 11:21:30","description":"This is a test rule","created_by":"email@email.com"}],"metadata":{"next_page_iterator":"1234567","count":2000}},"key":"Success","summary":"Success","id":"paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Success"},"paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled":{"value":{"error":{"code":"2.01","messages":["Fraud prevention is not enabled"]}},"key":"Error 2.01 Fraud prevention is not enabled","summary":"Error 2.01 Fraud prevention is not enabled","id":"paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled"},"paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1fraud-prevention-list-items~1list/post/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Success":{"value":{"id":"1234567","list_type":"pass","payment_field":"card_id","field_value":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","created_at":"2025-08-20 11:21:30","expired_at":"2025-12-21 11:21:30","description":"This is a pass rule","created_by":"email@email.com"},"key":"Success","summary":"Success","id":"paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Success"},"paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled":{"value":{"error":{"code":"2.01","messages":["Fraud prevention is not enabled"]}},"key":"Error 2.01 Fraud prevention is not enabled","summary":"Error 2.01 Fraud prevention is not enabled","id":"paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Fraud prevention is not enabled"},"paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Item not found":{"value":{"error":{"code":"2.01","messages":["Item not found"]}},"key":"Error 2.01 Item not found","summary":"Error 2.01 Item not found","id":"paths/~1fraud-prevention-list-items~1{id}/delete/responses/200/content/application~1json/examples/Error 2.01 Item not found"},"paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/Card dispute representment":{"value":{"dispute_type":"card","dispute_id":"123455667","evidence_file_id":"file_01AAABBBCCC123456"},"key":"Card dispute representment","summary":"Card dispute representment","id":"paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/Card dispute representment"},"paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/PayPal dispute representment":{"value":{"dispute_type":"paypal","dispute_id":"PP-D-123456789","evidence_file_id":"file_01AAABBBCCC123456"},"key":"PayPal dispute representment","summary":"PayPal dispute representment","id":"paths/~1dispute-representments~1create/post/requestBody/content/application~1json/examples/PayPal dispute representment"},"paths/~1dispute-representments~1create/post/responses/200/content/application~1json/examples/Success":{"value":{"id":"repr_10DDDEEEFFF123456"},"key":"Success","summary":"Success","id":"paths/~1dispute-representments~1create/post/responses/200/content/application~1json/examples/Success"},"paths/~1dispute-representments~1create/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1dispute-representments~1create/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1dispute-representments~1create/post/responses/400/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","constraints":{"dispute_id":[{"code":"NotBlank","message":"is required"}]},"message":"Validation error"}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1dispute-representments~1create/post/responses/400/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1dispute-representments~1create/post/responses/404/content/application~1json/examples/Error 2.01 Dispute not found":{"value":{"error":{"code":"2.01","message":"Dispute not found"}},"key":"Error 2.01 Dispute not found","summary":"Error 2.01 Dispute not found","id":"paths/~1dispute-representments~1create/post/responses/404/content/application~1json/examples/Error 2.01 Dispute not found"},"paths/~1dispute-representments~1create/post/responses/404/content/application~1json/examples/Error 2.01 File not found":{"value":{"error":{"code":"2.01","message":"File not found"}},"key":"Error 2.01 File not found","summary":"Error 2.01 File not found","id":"paths/~1dispute-representments~1create/post/responses/404/content/application~1json/examples/Error 2.01 File not found"},"paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File not ready":{"value":{"error":{"code":"2.01","message":"File not ready"}},"key":"Error 2.01 File not ready","summary":"Error 2.01 File not ready","id":"paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File not ready"},"paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File size exceeded":{"value":{"error":{"code":"2.01","message":"File size exceeded"}},"key":"Error 2.01 File size exceeded","summary":"Error 2.01 File size exceeded","id":"paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File size exceeded"},"paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File type not supported":{"value":{"error":{"code":"2.01","message":"File type not supported"}},"key":"Error 2.01 File type not supported","summary":"Error 2.01 File type not supported","id":"paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 File type not supported"},"paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 Representment already exists":{"value":{"error":{"code":"2.01","message":"Representment already exists"}},"key":"Error 2.01 Representment already exists","summary":"Error 2.01 Representment already exists","id":"paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 Representment already exists"},"paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 Representment not possible":{"value":{"error":{"code":"2.01","message":"Representment not possible"}},"key":"Error 2.01 Representment not possible","summary":"Error 2.01 Representment not possible","id":"paths/~1dispute-representments~1create/post/responses/422/content/application~1json/examples/Error 2.01 Representment not possible"},"paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/Card dispute representment enrichment":{"value":{"dispute_type":"card","dispute_id":"123455667","enrichment":{"proof_of_communication":[{"file_id":"file_01AAABBBCCC123451","annotation":"Email confirming subscription renewal."}],"application_logs":[{"file_id":"file_01AAABBBCCC12342","annotation":"User login history for disputed period."}],"proof_of_delivery":[{"file_id":"file_01AAABBBCCC12343","annotation":"Signed delivery confirmation."}],"invoice":[{"file_id":"file_01AAABBBCCC12344","annotation":"Invoice for order #12345."}],"receipts":[{"file_id":"file_01AAABBBCCC12345","annotation":"Payment receipt dated 2024-01-15."}],"other":[{"file_id":"file_01AAABBBCCC12346","annotation":"Terms of service accepted by customer."}]}},"key":"Card dispute representment enrichment","summary":"Card dispute representment enrichment","id":"paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/Card dispute representment enrichment"},"paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/PayPal dispute representment enrichment":{"value":{"dispute_type":"paypal","dispute_id":"PP-D-123456789","enrichment":{"proof_of_communication":[{"file_id":"file_01AAABBBCCC123451","annotation":"Email confirming subscription renewal."}],"application_logs":[{"file_id":"file_01AAABBBCCC12342","annotation":"User login history for disputed period."}],"proof_of_delivery":[{"file_id":"file_01AAABBBCCC12343","annotation":"Signed delivery confirmation."}],"invoice":[{"file_id":"file_01AAABBBCCC12344","annotation":"Invoice for order #12345."}],"receipts":[{"file_id":"file_01AAABBBCCC12345","annotation":"Payment receipt dated 2024-01-15."}],"other":[{"file_id":"file_01AAABBBCCC12346","annotation":"Terms of service accepted by customer."}]},"submit":false},"key":"PayPal dispute representment enrichment","summary":"PayPal dispute representment enrichment","id":"paths/~1dispute-representments~1enrich/post/requestBody/content/application~1json/examples/PayPal dispute representment enrichment"},"paths/~1dispute-representments~1enrich/post/responses/200/content/application~1json/examples/Success":{"value":{},"key":"Success","summary":"Success","id":"paths/~1dispute-representments~1enrich/post/responses/200/content/application~1json/examples/Success"},"paths/~1dispute-representments~1enrich/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1dispute-representments~1enrich/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1dispute-representments~1enrich/post/responses/400/content/application~1json/examples/Error 2.01 Invalid data":{"value":{"error":{"code":"2.01","constraints":{"dispute_id":[{"code":"NotBlank","message":"is required"}]},"message":"Validation error"}},"key":"Error 2.01 Invalid data","summary":"Error 2.01 Invalid data","id":"paths/~1dispute-representments~1enrich/post/responses/400/content/application~1json/examples/Error 2.01 Invalid data"},"paths/~1dispute-representments~1enrich/post/responses/404/content/application~1json/examples/Error 2.01 Dispute not found":{"value":{"error":{"code":"2.01","message":"Dispute not found"}},"key":"Error 2.01 Dispute not found","summary":"Error 2.01 Dispute not found","id":"paths/~1dispute-representments~1enrich/post/responses/404/content/application~1json/examples/Error 2.01 Dispute not found"},"paths/~1dispute-representments~1enrich/post/responses/404/content/application~1json/examples/Error 2.01 File not found":{"value":{"error":{"code":"2.01","message":"File not found"}},"key":"Error 2.01 File not found","summary":"Error 2.01 File not found","id":"paths/~1dispute-representments~1enrich/post/responses/404/content/application~1json/examples/Error 2.01 File not found"},"paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File not ready":{"value":{"error":{"code":"2.01","message":"File not ready"}},"key":"Error 2.01 File not ready","summary":"Error 2.01 File not ready","id":"paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File not ready"},"paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File size exceeded":{"value":{"error":{"code":"2.01","message":"File size exceeded"}},"key":"Error 2.01 File size exceeded","summary":"Error 2.01 File size exceeded","id":"paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File size exceeded"},"paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 Total files size exceeded":{"value":{"error":{"code":"2.01","message":"Total files size exceeded"}},"key":"Error 2.01 Total files size exceeded","summary":"Error 2.01 Total files size exceeded","id":"paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 Total files size exceeded"},"paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File type not supported":{"value":{"error":{"code":"2.01","message":"File type not supported"}},"key":"Error 2.01 File type not supported","summary":"Error 2.01 File type not supported","id":"paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 File type not supported"},"paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 Enrichment not possible":{"value":{"error":{"code":"2.01","message":"Enrichment not possible"}},"key":"Error 2.01 Enrichment not possible","summary":"Error 2.01 Enrichment not possible","id":"paths/~1dispute-representments~1enrich/post/responses/422/content/application~1json/examples/Error 2.01 Enrichment not possible"},"paths/~1init/post/requestBody/content/application~1json/examples/Payment":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","amount":1020,"currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","force3ds":false,"google_pay_allowed_auth_methods":["PAN_ONLY"],"customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+11234567890","billing_address":{"country":"USA","state":"NY","city":"New York","zip":"10001","address":"123 Main St"},"dynamic_descriptor":{"suffix":"PRODUCTX"},"payment_type_data":{"klarna_network_session_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.klarna_session_token_example","klarna_network_data":"{\"order_lines\":[{\"name\":\"Premium package\",\"quantity\":1,\"unit_price\":1020,\"total_amount\":1020}]}","sweden_pin":"19811228-9874"},"traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","language":"pt","website":"https://merchant.example","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"page_customization":{"public_name":"Public Name","order_title":"Order Title","order_description":"Premium package","payment_methods":["paypal","klarna-network"],"button_font_color":"#FFFFFF","button_color":"#00816A","font_name":"Open Sans","is_cardholder_visible":true,"terms_url":"https://merchant.example/terms","back_url":"https://merchant.example/back"}},"key":"Payment","summary":"Payment","id":"paths/~1init/post/requestBody/content/application~1json/examples/Payment"},"paths/~1init/post/requestBody/content/application~1json/examples/Subscription payment":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","product_id":"fa43b415-5522-4373-b026-a365562f9649","order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_number":9,"settle_interval":0,"authorization_type":"final","retry_attempt":3,"force3ds":false,"google_pay_allowed_auth_methods":["PAN_ONLY"],"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+11234567890","billing_address":{"country":"USA","state":"NY","city":"New York","zip":"10001","address":"123 Main St"},"dynamic_descriptor":{"suffix":"PRODUCTX"},"traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","language":"pt","website":"https://merchant.example","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"page_customization":{"public_name":"Public Name","order_title":"Order Title","order_description":"Premium package","payment_methods":["paypal"],"button_font_color":"#FFFFFF","button_color":"#00816A","font_name":"Open Sans","is_cardholder_visible":true,"terms_url":"https://merchant.example/terms","back_url":"https://merchant.example/back"}},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1init/post/requestBody/content/application~1json/examples/Subscription payment"},"paths/~1init/post/requestBody/content/application~1json/examples/Invoice payment":{"value":{"order":{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","order_items":"item 1 x 10, item 2 x 30","order_date":"2025-12-21 11:21:30","order_number":9,"settle_interval":0,"authorization_type":"final","force3ds":false,"google_pay_allowed_auth_methods":["PAN_ONLY"],"customer_date_of_birth":"1988-11-21","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","customer_phone":"+11234567890","billing_address":{"country":"USA","state":"NY","city":"New York","zip":"10001","address":"123 Main St"},"dynamic_descriptor":{"suffix":"PRODUCTX"},"traffic_source":"facebook","transaction_source":"main_menu","purchase_country":"USA","geo_country":"USA","geo_city":"New Castle","language":"pt","website":"https://merchant.example","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success","fail_url":"https://merchant.example/fail"},"page_customization":{"public_name":"Public Name","order_title":"Order Title","order_description":"Premium package","payment_methods":["paypal"],"button_font_color":"#FFFFFF","button_color":"#00816A","font_name":"Open Sans","is_cardholder_visible":true,"terms_url":"https://merchant.example/terms","back_url":"https://merchant.example/back"}},"key":"Invoice payment","summary":"Invoice payment","id":"paths/~1init/post/requestBody/content/application~1json/examples/Invoice payment"},"paths/~1init/post/responses/200/content/application~1json/examples/Success":{"value":{"url":"https://payment-page.merchant.example/VxKnj3D","id":"VxKnj3D"},"key":"Success","summary":"Success","id":"paths/~1init/post/responses/200/content/application~1json/examples/Success"},"paths/~1init/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","message":{"auth":"Authentication failed"}}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1init/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1init/post/responses/200/content/application~1json/examples/Error":{"value":{"error":{"code":"2.01","message":{"id":"must be a string"}}},"key":"Error","summary":"Error","id":"paths/~1init/post/responses/200/content/application~1json/examples/Error"},"paths/~1deactivate/post/responses/200/content/application~1json/examples/Success":{"value":{"status":"ok"},"key":"Success","summary":"Success","id":"paths/~1deactivate/post/responses/200/content/application~1json/examples/Success"},"paths/~1deactivate/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","message":{"auth":"Authentication failed"}}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1deactivate/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1deactivate/post/responses/400/content/application~1json/examples/Validation error":{"value":{"error":{"code":"2.01","message":{"id":"must be a string"}}},"key":"Validation error","summary":"Validation error","id":"paths/~1deactivate/post/responses/400/content/application~1json/examples/Validation error"},"paths/~1link~1init/post/requestBody/content/application~1json/examples/Payment":{"value":{"order":{"amount":1020,"currency":"EUR","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","settle_interval":0,"authorization_type":"final","google_pay_allowed_auth_methods":["PAN_ONLY"],"dynamic_descriptor":{"suffix":"PRODUCTX"},"payment_type_data":{"klarna_network_session_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.klarna_session_token_example","klarna_network_data":"{\"order_lines\":[{\"name\":\"Premium package\",\"quantity\":1,\"unit_price\":1020,\"total_amount\":1020}]}","sweden_pin":"19811228-9874"},"traffic_source":"facebook","transaction_source":"main_menu","language":"pt","website":"https://merchant.example","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success"},"page_customization":{"public_name":"Public Name","order_title":"Order Title","order_description":"Premium package","payment_methods":["paypal","klarna-network"],"button_font_color":"#FFFFFF","button_color":"#00816A","font_name":"Open Sans","is_cardholder_visible":true,"terms_url":"https://merchant.example/terms","back_url":"https://merchant.example/back"},"configuration":{"usage_mode":"reusable","amount_setter":"merchant"}},"key":"Payment","summary":"Payment","id":"paths/~1link~1init/post/requestBody/content/application~1json/examples/Payment"},"paths/~1link~1init/post/requestBody/content/application~1json/examples/Subscription payment":{"value":{"order":{"product_id":"fa43b415-5522-4373-b026-a365562f9649","order_description":"Premium package","settle_interval":0,"authorization_type":"final","google_pay_allowed_auth_methods":["PAN_ONLY"],"dynamic_descriptor":{"suffix":"PRODUCTX"},"traffic_source":"facebook","transaction_source":"main_menu","language":"pt","website":"https://merchant.example","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success"},"page_customization":{"public_name":"Public Name","order_title":"Order Title","order_description":"Premium package","payment_methods":["paypal"],"button_font_color":"#FFFFFF","button_color":"#00816A","font_name":"Open Sans","is_cardholder_visible":true,"terms_url":"https://merchant.example/terms","back_url":"https://merchant.example/back"}},"key":"Subscription payment","summary":"Subscription payment","id":"paths/~1link~1init/post/requestBody/content/application~1json/examples/Subscription payment"},"paths/~1link~1init/post/requestBody/content/application~1json/examples/Invoice payment":{"value":{"order":{"invoice_id":"inv_01KPWT0K1PQWEYYRT7J1H3NC85","future_usage":{"payment_type":"one-time"},"order_description":"Premium package","settle_interval":0,"authorization_type":"final","google_pay_allowed_auth_methods":["PAN_ONLY"],"dynamic_descriptor":{"suffix":"PRODUCTX"},"traffic_source":"facebook","transaction_source":"main_menu","language":"pt","website":"https://merchant.example","order_metadata":{"coupon_code":"NY2025","partner_id":"123989"},"success_url":"https://merchant.example/success"},"page_customization":{"public_name":"Public Name","order_title":"Order Title","order_description":"Premium package","payment_methods":["paypal"],"button_font_color":"#FFFFFF","button_color":"#00816A","font_name":"Open Sans","is_cardholder_visible":true,"terms_url":"https://merchant.example/terms","back_url":"https://merchant.example/back"},"configuration":{"usage_mode":"reusable","amount_setter":"merchant"}},"key":"Invoice payment","summary":"Invoice payment","id":"paths/~1link~1init/post/requestBody/content/application~1json/examples/Invoice payment"},"paths/~1link~1init/post/responses/200/content/application~1json/examples/Success":{"value":{"url":"https://payment-page.merchant.example/link/Q6J3212g7K","id":"Q6J3212g7K"},"key":"Success","summary":"Success","id":"paths/~1link~1init/post/responses/200/content/application~1json/examples/Success"},"paths/~1link~1init/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","message":{"auth":"Authentication failed"}}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1link~1init/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1link~1init/post/responses/200/content/application~1json/examples/Error":{"value":{"error":{"code":"2.01","message":{"id":"must be a string"}}},"key":"Error","summary":"Error","id":"paths/~1link~1init/post/responses/200/content/application~1json/examples/Error"},"paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Success":{"value":{"status":"ok"},"key":"Success","summary":"Success","id":"paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Success"},"paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","message":{"auth":"Authentication failed"}}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Validation error":{"value":{"error":{"code":"2.01","message":{"id":"must be a string"}}},"key":"Validation error","summary":"Validation error","id":"paths/~1link~1deactivate/post/responses/200/content/application~1json/examples/Validation error"},"paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/Without status":{"value":{"url":"https://merchant.example/webhook","event_types":["card_gate.order.updated","card_gate.chargeback.received"],"name":"Order status updates"},"key":"Without status","summary":"Without status","id":"paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/Without status"},"paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/With status":{"value":{"url":"https://merchant.example/webhook","event_types":["card_gate.order.updated","card_gate.chargeback.received"],"name":"Order status updates","status":"active"},"key":"With status","summary":"With status","id":"paths/~1webhooks~1endpoints/post/requestBody/content/application~1json/examples/With status"},"paths/~1webhooks~1endpoints/post/responses/200/content/application~1json/examples/Success":{"value":{"id":"5831596c-ba07-4bb5-b35a-cf08a28b4c3f","url":"https://merchant.example/webhook","event_types":["card_gate.order.updated","card_gate.chargeback.received"],"name":"Order status updates","status":"active","created_at":"2025-01-01 12:00:00","updated_at":"2025-01-02 12:00:00"},"key":"Success","summary":"Success","id":"paths/~1webhooks~1endpoints/post/responses/200/content/application~1json/examples/Success"},"paths/~1webhooks~1endpoints/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1webhooks~1endpoints/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid json":{"value":{"error":{"code":"2.01","message":"Invalid json"}},"key":"Error 2.01 Invalid json","summary":"Error 2.01 Invalid json","id":"paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid json"},"paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid url":{"value":{"error":{"code":"2.01","constraints":{"url":[{"code":"URL","message":"must be a valid value"}]},"message":"Validation error"}},"key":"Error 2.01 Invalid url","summary":"Error 2.01 Invalid url","id":"paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid url"},"paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid event_type":{"value":{"error":{"code":"2.01","constraints":{"event_types.0":[{"code":"Enum","message":"must be a valid value"}]},"message":"Validation error"}},"key":"Error 2.01 Invalid event_type","summary":"Error 2.01 Invalid event_type","id":"paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid event_type"},"paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid status":{"value":{"error":{"code":"2.01","constraints":{"status":[{"code":"Enum","message":"must be a valid value"}]},"message":"Validation error"}},"key":"Error 2.01 Invalid status","summary":"Error 2.01 Invalid status","id":"paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Invalid status"},"paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Name max length":{"value":{"error":{"code":"2.01","constraints":{"name":[{"code":"Length","message":"the length must be no more than 255"}]},"message":"Validation error"}},"key":"Error 2.01 Name max length","summary":"Error 2.01 Name max length","id":"paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 Name max length"},"paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 URL max length":{"value":{"error":{"code":"2.01","constraints":{"url":[{"code":"Length","message":"the length must be no more than 512"}]},"message":"Validation error"}},"key":"Error 2.01 URL max length","summary":"Error 2.01 URL max length","id":"paths/~1webhooks~1endpoints/post/responses/400/content/application~1json/examples/Error 2.01 URL max length"},"paths/~1webhooks~1endpoints/post/responses/422/content/application~1json/examples/Error 2.01 Endpoint already exists":{"value":{"error":{"code":"2.01","message":"Endpoint with the same URL for current channel already exists"}},"key":"Error 2.01 Endpoint already exists","summary":"Error 2.01 Endpoint already exists","id":"paths/~1webhooks~1endpoints/post/responses/422/content/application~1json/examples/Error 2.01 Endpoint already exists"},"paths/~1webhooks~1endpoints/post/responses/422/content/application~1json/examples/Error 2.01 Endpoint limit reached":{"value":{"error":{"code":"2.01","message":"Maximum endpoints per channel limit reached"}},"key":"Error 2.01 Endpoint limit reached","summary":"Error 2.01 Endpoint limit reached","id":"paths/~1webhooks~1endpoints/post/responses/422/content/application~1json/examples/Error 2.01 Endpoint limit reached"},"paths/~1webhooks~1endpoints/get/responses/200/content/application~1json/examples/Success":{"value":{"data":[{"id":"5831596c-ba07-4bb5-b35a-cf08a28b4c3f","url":"https://merchant.example/webhook","event_types":["card_gate.order.updated","card_gate.chargeback.received"],"name":"Order status updates","status":"active","created_at":"2025-01-01 12:00:00","updated_at":"2025-01-02 12:00:00"},{"id":"64033036-34ed-486e-bb0b-3b965560036a","url":"https://merchant.example/webhook","event_types":["card_gate.order.updated","card_gate.chargeback.received"],"name":"Order updates","status":"inactive","created_at":"2025-01-01 12:00:00","updated_at":"2025-01-02 12:00:00"}],"pagination":{"offset":2,"limit":2,"total_count":20}},"key":"Success","summary":"Success","id":"paths/~1webhooks~1endpoints/get/responses/200/content/application~1json/examples/Success"},"paths/~1webhooks~1endpoints/get/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1webhooks~1endpoints/get/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Invalid limit":{"value":{"error":{"code":"2.01","message":"Invalid limit value"}},"key":"Error 2.01 Invalid limit","summary":"Error 2.01 Invalid limit","id":"paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Invalid limit"},"paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Limit out of range":{"value":{"error":{"code":"2.01","message":"Limit must be between 1 and 100"}},"key":"Error 2.01 Limit out of range","summary":"Error 2.01 Limit out of range","id":"paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Limit out of range"},"paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Invalid offset":{"value":{"error":{"code":"2.01","message":"Invalid offset value"}},"key":"Error 2.01 Invalid offset","summary":"Error 2.01 Invalid offset","id":"paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Invalid offset"},"paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Negative offset":{"value":{"error":{"code":"2.01","message":"Offset cannot be negative"}},"key":"Error 2.01 Negative offset","summary":"Error 2.01 Negative offset","id":"paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Negative offset"},"paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 ID list exceeds maximum length":{"value":{"error":{"code":"2.01","message":"ID list exceeds maximum length of 50 items"}},"key":"Error 2.01 ID list exceeds maximum length","summary":"Error 2.01 ID list exceeds maximum length","id":"paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 ID list exceeds maximum length"},"paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Empty id in list":{"value":{"error":{"code":"2.01","message":"Empty ID at position 1"}},"key":"Error 2.01 Empty id in list","summary":"Error 2.01 Empty id in list","id":"paths/~1webhooks~1endpoints/get/responses/400/content/application~1json/examples/Error 2.01 Empty id in list"},"paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update all":{"value":{"event_types":["card_gate.order.updated","card.network_token.updated"],"name":"Order status updates","url":"https://merchant.example/webhook-updated","status":"active"},"key":"Update all","summary":"Update all","id":"paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update all"},"paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update event_types":{"value":{"event_types":["card_gate.order.updated","card.network_token.updated"]},"key":"Update event_types","summary":"Update event_types","id":"paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update event_types"},"paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update status":{"value":{"url":"https://merchant.example/webhook","event_types":["card_gate.order.updated","subscription.updated"],"status":"active"},"key":"Update status","summary":"Update status","id":"paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update status"},"paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update name":{"value":{"name":"Order status updates"},"key":"Update name","summary":"Update name","id":"paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update name"},"paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update url":{"value":{"url":"https://merchant.example/webhook-updated"},"key":"Update url","summary":"Update url","id":"paths/~1webhooks~1endpoints~1{id}/patch/requestBody/content/application~1json/examples/Update url"},"paths/~1webhooks~1endpoints~1{id}/patch/responses/200/content/application~1json/examples/Success":{"value":{"id":"5831596c-ba07-4bb5-b35a-cf08a28b4c3f","url":"https://merchant.example/webhook","event_types":["card_gate.order.updated","card_gate.chargeback.received"],"name":"Order status updates","status":"active","created_at":"2025-01-01 12:00:00","updated_at":"2025-01-02 12:00:00"},"key":"Success","summary":"Success","id":"paths/~1webhooks~1endpoints~1{id}/patch/responses/200/content/application~1json/examples/Success"},"paths/~1webhooks~1endpoints~1{id}/patch/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1webhooks~1endpoints~1{id}/patch/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid json":{"value":{"error":{"code":"2.01","message":"Invalid json"}},"key":"Error 2.01 Invalid json","summary":"Error 2.01 Invalid json","id":"paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid json"},"paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid event_type":{"value":{"error":{"code":"2.01","constraints":{"event_types.0":[{"code":"Enum","message":"must be a valid value"}]},"message":"Validation error"}},"key":"Error 2.01 Invalid event_type","summary":"Error 2.01 Invalid event_type","id":"paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid event_type"},"paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid status":{"value":{"error":{"code":"2.01","constraints":{"status":[{"code":"Enum","message":"must be a valid value"}]},"message":"Validation error"}},"key":"Error 2.01 Invalid status","summary":"Error 2.01 Invalid status","id":"paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid status"},"paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Name max length":{"value":{"error":{"code":"2.01","constraints":{"name":[{"code":"Length","message":"the length must be no more than 255"}]},"message":"Validation error"}},"key":"Error 2.01 Name max length","summary":"Error 2.01 Name max length","id":"paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Name max length"},"paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid url":{"value":{"error":{"code":"2.01","constraints":{"url":[{"code":"URL","message":"must be a valid value"}]},"message":"Validation error"}},"key":"Error 2.01 Invalid url","summary":"Error 2.01 Invalid url","id":"paths/~1webhooks~1endpoints~1{id}/patch/responses/400/content/application~1json/examples/Error 2.01 Invalid url"},"paths/~1webhooks~1endpoints~1{id}/patch/responses/404/content/application~1json/examples/Error 2.01 Endpoint not found":{"value":{"error":{"code":"2.01","message":"Endpoint not found"}},"key":"Error 2.01 Endpoint not found","summary":"Error 2.01 Endpoint not found","id":"paths/~1webhooks~1endpoints~1{id}/patch/responses/404/content/application~1json/examples/Error 2.01 Endpoint not found"},"paths/~1webhooks~1endpoints~1{id}/patch/responses/422/content/application~1json/examples/Error 2.01 Endpoint already exists":{"value":{"error":{"code":"2.01","message":"Endpoint with the same URL for current channel already exists"}},"key":"Error 2.01 Endpoint already exists","summary":"Error 2.01 Endpoint already exists","id":"paths/~1webhooks~1endpoints~1{id}/patch/responses/422/content/application~1json/examples/Error 2.01 Endpoint already exists"},"paths/~1webhooks~1endpoints~1{id}/delete/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1webhooks~1endpoints~1{id}/delete/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1card-orders/post/responses/200/content/application~1json/examples/Success":{"value":{"orders":[{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","psp_order_id":"854756336423874823bdfsg6743gf5","provider_payment_id":"charge_64789DFS3827563HGF56","product_id":"a12b3c4d-5678-90ab-cdef-1234567890ab","product_name":"Premium package","product_type":"recurring","subscription_id":"b64f6196-5d39-47a8-9bfa-3a39501c6c44","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","processing_amount":10,"processing_currency":"USD","settled_amount":0,"settled_currency":null,"refunded_amount":0,"refunded_currency":null,"status":"processing","refund":null,"payment_type":"recurring","payment_method":"token","type":"recurring","is_secured":true,"routing":{"cascade_steps":[{"mid":"mid-1","mid_descriptor":"descriptor-1","route_id":"pm-1","cascade_number":1,"segment_id":"fps_43bf3b784db24044446e8806723ff5ca","connector_account_id":"01K7RF79XMK2FNV66Y84ZPMCAE"}]},"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","mid":"bank-mid-1","ip_address":"203.0.113.0","traffic_source":"facebook","platform":"MOB","geo_country":"USA","error_code":"3.02","transactions":[{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","created_at":"2026-07-15 11:45:30","updated_at":"2026-07-16 11:45:30","amount":100,"currency":"USD","operation":"recurring","status":"processing","authorization_type":"final","original_payment_method":"apple-pay","descriptor":"google.com","refund_reason":"Solidgate - Issuer Fraud Notification","refund_reason_code":"0022","card":{"bank":"JSC UNIVERSAL BANK","bin":"444111","brand":"VISA","card_exp_month":"12","card_exp_year":2030,"card_holder":"John Snow","card_type":"CREDIT","card_id":"22733af4-f6c6-4368-b7d0-98aeb0253a57","country":"USA","number":"444111XXXXXX9435"}}],"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}],"metadata":{"next_page_iterator":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9","count":1}},"key":"Success","summary":"Success","id":"paths/~1card-orders/post/responses/200/content/application~1json/examples/Success"},"paths/~1card-orders/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1card-orders/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1apm-orders/post/responses/200/content/application~1json/examples/Success":{"value":{"orders":[{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","product_id":"a12b3c4d-5678-90ab-cdef-1234567890ab","product_name":"Premium package","product_type":"recurring","subscription_id":"b64f6196-5d39-47a8-9bfa-3a39501c6c44","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","method":"paypal-vault","amount":100,"currency":"USD","processing_amount":0,"processing_currency":"USD","settled_amount":0,"settled_currency":null,"refunded_amount":0,"refunded_currency":null,"status":"processing","refund":null,"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","ip_address":"203.0.113.0","geo_country":"USA","error_code":"3.02","transactions":[{"id":"5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a","psp_transaction_id":"txn_5019d00bb70f82cd42f6bc654cbdfcbd63a9","created_at":"2025-12-28 11:45:30","updated_at":"2025-12-29 11:45:30","method":"paypal-vault","amount":100,"currency":"USD","status":"processing","type":"pay"}],"order_metadata":{"coupon_code":"NY2025","partner_id":"123989"}}],"metadata":{"next_page_iterator":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9","count":1}},"key":"Success","summary":"Success","id":"paths/~1apm-orders/post/responses/200/content/application~1json/examples/Success"},"paths/~1apm-orders/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1apm-orders/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1subscriptions/post/responses/200/content/application~1json/examples/Success":{"value":{"subscriptions":{"<subscription_id_value_#1>":{"id":"64e1c283-17bf-45a7-90ea-2cb938081b2f","status":"cancelled","updated_at":"2025-06-10 15:42:25","started_at":"2025-06-10 15:42:24","expired_at":"2025-09-10 16:42:24","next_charge_at":"2025-11-26 11:43:52","payment_type":"paypal-vault","trial":true,"cancelled_at":"2025-06-26 06:43:58","cancel_code":"8.01","cancel_message":"Card brand is not supported","customer":{"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"},"product":{"id":"a51ba9fd-3be1-4ef9-b00f-bb85157597f5","name":"Platinum Audiobook Set","payment_action":"auth_void","amount":100,"currency":"USD","trial":true,"trial_period":1},"invoices":{"<invoice_id_value_#1>":{"id":"4022a203-ace8-415f-9ae7-730014fceb25","status":"fail","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-28 11:45:30","amount":100,"billing_period_started_at":"2025-12-29 11:45:30","billing_period_ended_at":"2025-12-30 11:45:30","subscription_term_number":1,"orders":{"<order_id_value_#1>":{"id":"1672066481283AlexKho","status":"processing","created_at":"2025-12-27 11:45:30","processed_at":"2025-12-28 11:45:30","operation":"pay","amount":100,"payment_details":{"invoice_id":"12344333-3ace-415f-9ae7-730014fceb25","payer_email":"example@example.com"},"retry_attempt":0}}}},"pause":{"from_date":"2026-01-27 11:26:08","to_date":"2026-01-27 11:26:08"}}},"metadata":{"next_page_iterator":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9","count":1}},"key":"Success","summary":"Success","id":"paths/~1subscriptions/post/responses/200/content/application~1json/examples/Success"},"paths/~1subscriptions/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1subscriptions/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1card-orders~1chargebacks/post/responses/200/content/application~1json/examples/Success":{"value":{"orders":[{"order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","order_description":"Premium package","created_at":"2025-08-18 09:57:42","updated_at":"2025-08-18 09:57:42","amount":100,"currency":"USD","status":"settle_ok","type":"pay","is_secured":false,"customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com","customer_first_name":"Nikola","customer_last_name":"Tesla","ip_address":"203.0.113.0","platform":"WEB","geo_country":"USA","chargebacks":[{"id":"892140","created_at":"2025-08-18 09:57:49","updated_at":"2025-08-18 09:57:49","dispute_date":"2025-08-18 09:57:49","settlement_date":"2025-08-18 09:57:49","amount":100,"currency":"USD","type":"1st_chb","status":"reversed","reason_group":"Fraud","reason_code":"10.4","reason_description":"Fraud – Card-Absent Environment","flows":[{"id":"1159271","date":"2025-08-18 00:00:00","created_at":"2025-08-18 09:57:48","updated_at":"2025-08-18 09:57:49","settlement_date":"2025-08-18 00:00:00","deadline_date":"2025-08-28 00:00:00","amount":100,"dispute_amount":100,"currency":"USD","type":"1st_chb","status":"in_progress","represented_by":"merchant","arn_code":"24871153022084127852235"}]}]}],"metadata":{"next_page_iterator":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9","count":1}},"key":"Success","summary":"Success","id":"paths/~1card-orders~1chargebacks/post/responses/200/content/application~1json/examples/Success"},"paths/~1card-orders~1chargebacks/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1card-orders~1chargebacks/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1apm-orders~1paypal-disputes/post/responses/200/content/application~1json/examples/Success":{"value":{"disputes":[{"dispute_id":"PP-D-85112454","order_id":"923bb4e6-4a5f-41ec-81fb-28eb8a152e55","subscription_product_id":"ac43b415-5522-4373-b026-a365462f9657","subscription_service_id":"fb603790-1234-1111-9876-ae4d59d5d378","created_at":"2025-08-23 12:05:28","updated_at":"2025-08-23 12:05:28","seller_response_due_date":"2025-09-14 16:29:12","dispute_amount":100,"dispute_currency":"USD","dispute_life_cycle_stage":"INQUIRY","dispute_channel":"INTERNAL","dispute_create_time":"2025-07-02 23:39:06","dispute_update_time":"2025-07-08 1:40:44","dispute_outcome":"RESOLVED_WITH_PAYOUT","reason":"MERCHANDISE_OR_SERVICE_NOT_RECEIVED","status":"WAITING_FOR_BUYER_RESPONSE","represented_by":"automation","customer_account_id":"93a1c659-288d-4d62-929d-10e241078faa","customer_email":"example@example.com"}],"metadata":{"next_page_iterator":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9","count":1}},"key":"Success","summary":"Success","id":"paths/~1apm-orders~1paypal-disputes/post/responses/200/content/application~1json/examples/Success"},"paths/~1apm-orders~1paypal-disputes/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1apm-orders~1paypal-disputes/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1prevention_alerts/post/responses/200/content/application~1json/examples/Success":{"value":{"report_url":"https://reports.solidgate.com/api/v1/prevention_alerts/report/prevent_report_240808_143924_test/download"},"key":"Success","summary":"Success","id":"paths/~1prevention_alerts/post/responses/200/content/application~1json/examples/Success"},"paths/~1prevention_alerts/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1prevention_alerts/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success":{"value":{"report_url":"https://reports.solidgate.com/api/v1/prevention_alerts/report/PREVENT_250702_140728_CHECKOUT/download"},"key":"Success","summary":"Success","id":"paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success"},"paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Invalid data","summary":"Invalid data","id":"paths/~1prevention_alerts~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"},"paths/~1card-orders~1fraud-alerts/post/responses/200/content/application~1json/examples/Success":{"value":{"alerts":[{"id":9148812,"order_id":"923bb4e6-4a5f-41ec-81fb-48eb8a152e55","created_at":"2025-12-27 11:45:30","updated_at":"2025-12-27 11:45:30","fraud_amount":50,"fraud_currency":"USD","fraud_amount_usd":100,"fraud_report_date":"2025-03-24 14:22:15","fraud_type":"6","card_scheme":"VISA","reason_code_description":"Fraudulent Use of Account Number"}],"metadata":{"next_page_iterator":"eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9","count":1}},"key":"Success","summary":"Success","id":"paths/~1card-orders~1fraud-alerts/post/responses/200/content/application~1json/examples/Success"},"paths/~1card-orders~1fraud-alerts/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1card-orders~1fraud-alerts/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1financial_entries/post/responses/200/content/application~1json/examples/Success":{"value":{"report_url":"https://reports.solidgate.com/api/v1/finance/financial_entries/report/fin_220808_143924_test/download"},"key":"Success","summary":"Success","id":"paths/~1financial_entries/post/responses/200/content/application~1json/examples/Success"},"paths/~1financial_entries/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1financial_entries/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success":{"value":{"report_url":"https://reports.solidgate.com/api/v1/finance/financial_entries/report/FIN_250702_140728_CHECKOUT/download"},"key":"Success","summary":"Success","id":"paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success"},"paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Invalid data","summary":"Invalid data","id":"paths/~1financial_entries~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"},"paths/~1routing~1events/post/responses/200/content/application~1json/examples/Success":{"value":{"report_url":"https://reports.solidgate.com/api/v1/routing/events/report/routing_240808_143924_test/download"},"key":"Success","summary":"Success","id":"paths/~1routing~1events/post/responses/200/content/application~1json/examples/Success"},"paths/~1routing~1events/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1routing~1events/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success":{"value":{"report_url":"https://reports.solidgate.com/api/v1/routing/events/report/ROUTING_250702_140728_CHECKOUT/download"},"key":"Success","summary":"Success","id":"paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Success"},"paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data":{"value":{"error":{"code":"2.01","messages":["Invalid data"]}},"key":"Invalid data","summary":"Invalid data","id":"paths/~1routing~1events~1report~1{report_id}~1download/get/responses/200/content/application~1json/examples/Invalid data"},"paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Success":{"value":{"file_id":"file_01AAABBBCCC123456","upload_url":"https://storage.example.com/file/x?signature=123"},"key":"Success","summary":"Success","id":"paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Success"},"paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Authentication failed":{"value":{"error":{"code":"1.01","messages":["Authentication failed"]}},"key":"Authentication failed","summary":"Authentication failed","id":"paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Authentication failed"},"paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Error 2.01 Validation error":{"value":{"error":{"code":"2.01","message":"Invalid request","constraints":{"file_size":[{"code":"InvalidSize","message":"file_size must be less than 52428800 bytes"}],"file_type":[{"code":"InvalidExtension","message":"file_type extension is not supported"}]}}},"key":"Error 2.01 Validation error","summary":"Error 2.01 Validation error","id":"paths/~1file~1get-upload-url/post/responses/200/content/application~1json/examples/Error 2.01 Validation error"}},"securitySchemeStore":{"MerchantID":{"id":"MerchantID","type":"apiKey","in":"header","paramName":"Merchant id"}},"servers":[{"url":"https://pay.solidgate.com/api/v1","description":"Card payments API"},{"url":"https://gate.solidgate.com/api/v1","description":"Alternative payment methods API"},{"url":"https://subscriptions.solidgate.com/api/v1","description":"Subscriptions API"},{"url":"https://payment-page.solidgate.com/api/v1","description":"Payment Page API"},{"url":"https://reports.solidgate.com/api/v1","description":"Reports API"},{"url":"https://risks.solidgate.com/api/v1","description":"Risks API"},{"url":"https://api.solidgate.com/api/v1","description":"General API"}],"logo":{"imageUrl":"https://cdn.solidgate.com/logos/logo_api_sld.svg","altText":"Solidgate logo","backgroundColor":"#fafafa"}},"options":{"hideReplay":true,"hideSchemaTitles":true,"maxDisplayedEnumValues":3,"jsonSamplesExpandLevel":1,"schemasExpansionLevel":0,"hideDownloadButtons":true,"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/api/@v1/index.json?download"},{"url":"/_bundle/api/@v1/index.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"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 !important;max-width:96px !important;flex:0 0 96px !important;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 24 24\" fill=\"#fff\" style=\"width:14px !important;height:14px !important;max-width:14px !important;max-height:14px !important;flex-shrink:0;display:inline-block;\">\n      <path d=\"m0 .97 4.111 6.453v4.09h2.638v-4.09L11.053.969H8.214L5.58 5.125 2.965.969Zm12.093.024-4.47 10.544h2.114l.97-2.345h4.775l.804 2.345h2.26L14.255.994Zm1.133 2.225 1.463 3.87h-3.096zm3.06 9.475v10.29H24v-2.199h-5.454v-8.091zm-12.175.002v10.335h2.217v-7.129l2.32 4.792h1.746l2.4-4.96v7.295h2.127V12.696h-2.904L9.44 17.37l-2.455-4.674Z\"/>\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 !important;max-width:96px !important;flex:0 0 96px !important;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 24 24\" fill=\"#fff\" style=\"width:14px !important;height:14px !important;max-width:14px !important;max-height:14px !important;flex-shrink:0;display:inline-block;\">\n      <path d=\"M12.043 23.968c.479-.004.953-.029 1.426-.094a11.805 11.805 0 003.146-.863 12.404 12.404 0 003.793-2.542 11.977 11.977 0 002.44-3.427 11.794 11.794 0 001.02-3.476c.149-1.16.135-2.346-.045-3.499a11.96 11.96 0 00-.793-2.788 11.197 11.197 0 00-.854-1.617c-1.168-1.837-2.861-3.314-4.81-4.3a12.835 12.835 0 00-2.172-.87h-.005c.119.063.24.132.345.201.12.074.239.146.351.225a8.93 8.93 0 011.559 1.33c1.063 1.145 1.797 2.548 2.218 4.041.284.982.434 1.998.495 3.017.044.743.044 1.491-.047 2.229-.149 1.27-.554 2.51-1.228 3.596a7.475 7.475 0 01-1.903 2.084c-1.244.928-2.877 1.482-4.436 1.114a3.916 3.916 0 01-.748-.258 4.692 4.692 0 01-.779-.45 6.08 6.08 0 01-1.244-1.105 6.507 6.507 0 01-1.049-1.747 7.366 7.366 0 01-.494-2.54c-.03-1.273.225-2.553.854-3.67a6.43 6.43 0 011.663-1.918c.225-.178.464-.333.704-.479l.016-.007a5.121 5.121 0 00-1.441-.12 4.963 4.963 0 00-1.228.24c-.359.12-.704.27-1.019.45a6.146 6.146 0 00-.733.494c-.211.18-.42.36-.615.555-1.123 1.153-1.768 2.682-2.022 4.256-.15.973-.15 1.96-.091 2.95.105 1.395.391 2.787.945 4.062a8.518 8.518 0 001.348 2.173 8.14 8.14 0 003.132 2.23 7.934 7.934 0 002.113.54c.074.015.149.015.209.015zm-2.934-.398a4.102 4.102 0 01-.45-.228 8.5 8.5 0 01-2.038-1.534c-1.094-1.137-1.827-2.566-2.247-4.08a15.184 15.184 0 01-.495-3.172 12.14 12.14 0 01.046-2.082c.135-1.257.495-2.501 1.124-3.58a6.889 6.889 0 011.783-2.053 6.23 6.23 0 011.633-.9 5.363 5.363 0 013.522-.045c.029 0 .029 0 .045.03.015.015.045.015.06.03.045.016.104.045.165.074.239.12.479.271.704.42a6.294 6.294 0 012.097 2.502c.42.914.615 1.934.631 2.938.014 1.079-.18 2.157-.645 3.146a6.42 6.42 0 01-2.638 2.832c.09.03.18.045.271.075.225.044.449.074.688.074 1.468.045 2.892-.66 3.94-1.647.195-.18.375-.375.54-.585.225-.27.435-.54.614-.823.239-.375.435-.75.614-1.154a8.112 8.112 0 00.509-1.664c.196-1.004.211-2.022.149-3.026-.135-2.022-.673-4.045-1.842-5.724a9.054 9.054 0 00-.555-.719 9.868 9.868 0 00-1.063-1.034 8.477 8.477 0 00-1.363-.915 9.927 9.927 0 00-1.692-.598l-.3-.06c-.209-.03-.42-.044-.634-.06a8.453 8.453 0 00-1.015.016c-.704.045-1.412.16-2.112.337C5.799 1.227 2.863 3.566 1.3 6.67A11.834 11.834 0 00.238 9.801a11.81 11.81 0 00-.104 3.775c.12 1.02.374 2.023.778 2.977.227.57.511 1.124.825 1.648 1.094 1.783 2.683 3.236 4.51 4.24.688.39 1.408.69 2.157.944.226.074.45.15.689.21z\"/>\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 !important;max-width:96px !important;flex:0 0 96px !important;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"18\" height=\"18\" viewBox=\"0 0 24 24\" fill=\"none\" style=\"width:18px !important;height:18px !important;max-width:18px !important;max-height:18px !important;flex-shrink:0;display:inline-block;\" 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 !important;max-width:96px !important;flex:0 0 96px !important;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 24 24\" fill=\"#fff\" style=\"width:14px !important;height:14px !important;max-width:14px !important;max-height:14px !important;flex-shrink:0;display:inline-block;\">\n      <path d=\"M14.23 12.004a2.236 2.236 0 0 1-2.235 2.236 2.236 2.236 0 0 1-2.236-2.236 2.236 2.236 0 0 1 2.235-2.236 2.236 2.236 0 0 1 2.236 2.236zm2.648-10.69c-1.346 0-3.107.96-4.888 2.622-1.78-1.653-3.542-2.602-4.887-2.602-.41 0-.783.093-1.106.278-1.375.793-1.683 3.264-.973 6.365C1.98 8.917 0 10.42 0 12.004c0 1.59 1.99 3.097 5.043 4.03-.704 3.113-.39 5.588.988 6.38.32.187.69.275 1.102.275 1.345 0 3.107-.96 4.888-2.624 1.78 1.654 3.542 2.603 4.887 2.603.41 0 .783-.09 1.106-.275 1.374-.792 1.683-3.263.973-6.365C22.02 15.096 24 13.59 24 12.004c0-1.59-1.99-3.097-5.043-4.032.704-3.11.39-5.587-.988-6.38-.318-.184-.688-.277-1.092-.278zm-.005 1.09v.006c.225 0 .406.044.558.127.666.382.955 1.835.73 3.704-.054.46-.142.945-.25 1.44-.96-.236-2.006-.417-3.107-.534-.66-.905-1.345-1.727-2.035-2.447 1.592-1.48 3.087-2.292 4.105-2.295zm-9.77.02c1.012 0 2.514.808 4.11 2.28-.686.72-1.37 1.537-2.02 2.442-1.107.117-2.154.298-3.113.538-.112-.49-.195-.964-.254-1.42-.23-1.868.054-3.32.714-3.707.19-.09.4-.127.563-.132zm4.882 3.05c.455.468.91.992 1.36 1.564-.44-.02-.89-.034-1.345-.034-.46 0-.915.01-1.36.034.44-.572.895-1.096 1.345-1.565zM12 8.1c.74 0 1.477.034 2.202.093.406.582.802 1.203 1.183 1.86.372.64.71 1.29 1.018 1.946-.308.655-.646 1.31-1.013 1.95-.38.66-.773 1.288-1.18 1.87-.728.063-1.466.098-2.21.098-.74 0-1.477-.035-2.202-.093-.406-.582-.802-1.204-1.183-1.86-.372-.64-.71-1.29-1.018-1.946.303-.657.646-1.313 1.013-1.954.38-.66.773-1.286 1.18-1.868.728-.064 1.466-.098 2.21-.098zm-3.635.254c-.24.377-.48.763-.704 1.16-.225.39-.435.782-.635 1.174-.265-.656-.49-1.31-.676-1.947.64-.15 1.315-.283 2.015-.386zm7.26 0c.695.103 1.365.23 2.006.387-.18.632-.405 1.282-.66 1.933-.2-.39-.41-.783-.64-1.174-.225-.392-.465-.774-.705-1.146zm3.063.675c.484.15.944.317 1.375.498 1.732.74 2.852 1.708 2.852 2.476-.005.768-1.125 1.74-2.857 2.475-.42.18-.88.342-1.355.493-.28-.958-.646-1.956-1.1-2.98.45-1.017.81-2.01 1.085-2.964zm-13.395.004c.278.96.645 1.957 1.1 2.98-.45 1.017-.812 2.01-1.086 2.964-.484-.15-.944-.318-1.37-.5-1.732-.737-2.852-1.706-2.852-2.474 0-.768 1.12-1.742 2.852-2.476.42-.18.88-.342 1.356-.494zm11.678 4.28c.265.657.49 1.312.676 1.948-.64.157-1.316.29-2.016.39.24-.375.48-.762.705-1.158.225-.39.435-.788.636-1.18zm-9.945.02c.2.392.41.783.64 1.175.23.39.465.772.705 1.143-.695-.102-1.365-.23-2.006-.386.18-.63.406-1.282.66-1.933zM17.92 16.32c.112.493.2.968.254 1.423.23 1.868-.054 3.32-.714 3.708-.147.09-.338.128-.563.128-1.012 0-2.514-.807-4.11-2.28.686-.72 1.37-1.536 2.02-2.44 1.107-.118 2.154-.3 3.113-.54zm-11.83.01c.96.234 2.006.415 3.107.532.66.905 1.345 1.727 2.035 2.446-1.595 1.483-3.092 2.295-4.11 2.295-.22-.005-.406-.05-.553-.132-.666-.38-.955-1.834-.73-3.703.054-.46.142-.944.25-1.438zm4.56.64c.44.02.89.034 1.345.034.46 0 .915-.01 1.36-.034-.44.572-.895 1.095-1.345 1.565-.455-.47-.91-.993-1.36-1.565z\"/>\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 !important;max-width:96px !important;flex:0 0 96px !important;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 24 24\" fill=\"#fff\" style=\"width:14px !important;height:14px !important;max-width:14px !important;max-height:14px !important;flex-shrink:0;display:inline-block;\">\n      <path d=\"M24,1.61H14.06L12,5.16,9.94,1.61H0L12,22.39ZM12,14.08,5.16,2.23H9.59L12,6.41l2.41-4.18h4.43Z\"/>\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 !important;max-width:96px !important;flex:0 0 96px !important;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 24 24\" fill=\"#fff\" style=\"width:14px !important;height:14px !important;max-width:14px !important;max-height:14px !important;flex-shrink:0;display:inline-block;\">\n      <path d=\"M16.712 17.711H7.288l-1.204 2.916L12 24l5.916-3.373-1.204-2.916ZM14.692 0l7.832 16.855.814-12.856L14.692 0ZM9.308 0 .662 3.999l.814 12.856L9.308 0Zm-.405 13.93h6.198L12 6.396 8.903 13.93Z\"/>\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 !important;max-width:96px !important;flex:0 0 96px !important;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 24 24\" fill=\"#fff\" style=\"width:14px !important;height:14px !important;max-width:14px !important;max-height:14px !important;flex-shrink:0;display:inline-block;\">\n      <path d=\"M11.998,24c-0.321,0-0.641-0.084-0.922-0.247l-2.936-1.737c-0.438-0.245-0.224-0.332-0.08-0.383 c0.585-0.203,0.703-0.25,1.328-0.604c0.065-0.037,0.151-0.023,0.218,0.017l2.256,1.339c0.082,0.045,0.197,0.045,0.272,0l8.795-5.076 c0.082-0.047,0.134-0.141,0.134-0.238V6.921c0-0.099-0.053-0.192-0.137-0.242l-8.791-5.072c-0.081-0.047-0.189-0.047-0.271,0 L3.075,6.68C2.99,6.729,2.936,6.825,2.936,6.921v10.15c0,0.097,0.054,0.189,0.139,0.235l2.409,1.392 c1.307,0.654,2.108-0.116,2.108-0.89V7.787c0-0.142,0.114-0.253,0.256-0.253h1.115c0.139,0,0.255,0.112,0.255,0.253v10.021 c0,1.745-0.95,2.745-2.604,2.745c-0.508,0-0.909,0-2.026-0.551L2.28,18.675c-0.57-0.329-0.922-0.945-0.922-1.604V6.921 c0-0.659,0.353-1.275,0.922-1.603l8.795-5.082c0.557-0.315,1.296-0.315,1.848,0l8.794,5.082c0.57,0.329,0.924,0.944,0.924,1.603 v10.15c0,0.659-0.354,1.273-0.924,1.604l-8.794,5.078C12.643,23.916,12.324,24,11.998,24z M19.099,13.993 c0-1.9-1.284-2.406-3.987-2.763c-2.731-0.361-3.009-0.548-3.009-1.187c0-0.528,0.235-1.233,2.258-1.233 c1.807,0,2.473,0.389,2.747,1.607c0.024,0.115,0.129,0.199,0.247,0.199h1.141c0.071,0,0.138-0.031,0.186-0.081 c0.048-0.054,0.074-0.123,0.067-0.196c-0.177-2.098-1.571-3.076-4.388-3.076c-2.508,0-4.004,1.058-4.004,2.833 c0,1.925,1.488,2.457,3.895,2.695c2.88,0.282,3.103,0.703,3.103,1.269c0,0.983-0.789,1.402-2.642,1.402 c-2.327,0-2.839-0.584-3.011-1.742c-0.02-0.124-0.126-0.215-0.253-0.215h-1.137c-0.141,0-0.254,0.112-0.254,0.253 c0,1.482,0.806,3.248,4.655,3.248C17.501,17.007,19.099,15.91,19.099,13.993z\"/>\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 !important;max-width:96px !important;flex:0 0 96px !important;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 24 24\" fill=\"#fff\" style=\"width:14px !important;height:14px !important;max-width:14px !important;max-height:14px !important;flex-shrink:0;display:inline-block;\">\n      <path d=\"M7.01 10.207h-.944l-.515 2.648h.838c.556 0 .97-.105 1.242-.314.272-.21.455-.559.55-1.049.092-.47.05-.802-.124-.995-.175-.193-.523-.29-1.047-.29zM12 5.688C5.373 5.688 0 8.514 0 12s5.373 6.313 12 6.313S24 15.486 24 12c0-3.486-5.373-6.312-12-6.312zm-3.26 7.451c-.261.25-.575.438-.917.551-.336.108-.765.164-1.285.164H5.357l-.327 1.681H3.652l1.23-6.326h2.65c.797 0 1.378.209 1.744.628.366.418.476 1.002.33 1.752a2.836 2.836 0 0 1-.305.847c-.143.255-.33.49-.561.703zm4.024.715l.543-2.799c.063-.318.039-.536-.068-.651-.107-.116-.336-.174-.687-.174H11.46l-.704 3.625H9.388l1.23-6.327h1.367l-.327 1.682h1.218c.767 0 1.295.134 1.586.401s.378.7.263 1.299l-.572 2.944h-1.389zm7.597-2.265a2.782 2.782 0 0 1-.305.847c-.143.255-.33.49-.561.703a2.44 2.44 0 0 1-.917.551c-.336.108-.765.164-1.286.164h-1.18l-.327 1.682h-1.378l1.23-6.326h2.649c.797 0 1.378.209 1.744.628.366.417.477 1.001.331 1.751zM17.766 10.207h-.943l-.516 2.648h.838c.557 0 .971-.105 1.242-.314.272-.21.455-.559.551-1.049.092-.47.049-.802-.125-.995s-.524-.29-1.047-.29z\"/>\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 !important;max-width:96px !important;flex:0 0 96px !important;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 24 24\" fill=\"#fff\" style=\"width:14px !important;height:14px !important;max-width:14px !important;max-height:14px !important;flex-shrink:0;display:inline-block;\">\n      <path d=\"M1.811 10.231c-.047 0-.058-.023-.035-.059l.246-.315c.023-.035.081-.058.128-.058h4.172c.046 0 .058.035.035.07l-.199.303c-.023.036-.082.07-.117.07zM.047 11.306c-.047 0-.059-.023-.035-.058l.245-.316c.023-.035.082-.058.129-.058h5.328c.047 0 .07.035.058.07l-.093.28c-.012.047-.058.07-.105.07zm2.828 1.075c-.047 0-.059-.035-.035-.07l.163-.292c.023-.035.07-.07.117-.07h2.337c.047 0 .07.035.07.082l-.023.28c0 .047-.047.082-.082.082zm12.129-2.36c-.736.187-1.239.327-1.963.514-.176.046-.187.058-.34-.117-.174-.199-.303-.327-.548-.444-.737-.362-1.45-.257-2.115.175-.795.514-1.204 1.274-1.192 2.22.011.935.654 1.706 1.577 1.835.795.105 1.46-.175 1.987-.77.105-.13.198-.27.315-.434H10.47c-.245 0-.304-.152-.222-.35.152-.362.432-.97.596-1.274a.315.315 0 01.292-.187h4.253c-.023.316-.023.631-.07.947a4.983 4.983 0 01-.958 2.29c-.841 1.11-1.94 1.8-3.33 1.986-1.145.152-2.209-.07-3.143-.77-.865-.655-1.356-1.52-1.484-2.595-.152-1.274.222-2.419.993-3.424.83-1.086 1.928-1.776 3.272-2.02 1.098-.2 2.15-.07 3.096.571.62.41 1.063.97 1.356 1.648.07.105.023.164-.117.2m3.868 6.461c-1.064-.024-2.034-.328-2.852-1.029a3.665 3.665 0 01-1.262-2.255c-.21-1.32.152-2.489.947-3.529.853-1.122 1.881-1.706 3.272-1.95 1.192-.21 2.314-.095 3.33.595.923.63 1.496 1.484 1.648 2.605.198 1.578-.257 2.863-1.344 3.962-.771.783-1.718 1.273-2.805 1.495-.315.06-.63.07-.934.106zm2.78-4.72c-.011-.153-.011-.27-.034-.387-.21-1.157-1.274-1.81-2.384-1.554-1.087.245-1.788.935-2.045 2.033-.21.912.234 1.835 1.075 2.21.643.28 1.285.244 1.905-.07.923-.48 1.425-1.228 1.484-2.233z\"/>\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 !important;max-width:96px !important;flex:0 0 96px !important;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 24 24\" fill=\"#fff\" style=\"width:14px !important;height:14px !important;max-width:14px !important;max-height:14px !important;flex-shrink:0;display:inline-block;\">\n      <path d=\"M24 24H0V0h24L12 12Z\"/>\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 !important;max-width:96px !important;flex:0 0 96px !important;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 24 24\" fill=\"#fff\" style=\"width:14px !important;height:14px !important;max-width:14px !important;max-height:14px !important;flex-shrink:0;display:inline-block;\">\n      <path d=\"M14.25.18l.9.2.73.26.59.3.45.32.34.34.25.34.16.33.1.3.04.26.02.2-.01.13V8.5l-.05.63-.13.55-.21.46-.26.38-.3.31-.33.25-.35.19-.35.14-.33.1-.3.07-.26.04-.21.02H8.77l-.69.05-.59.14-.5.22-.41.27-.33.32-.27.35-.2.36-.15.37-.1.35-.07.32-.04.27-.02.21v3.06H3.17l-.21-.03-.28-.07-.32-.12-.35-.18-.36-.26-.36-.36-.35-.46-.32-.59-.28-.73-.21-.88-.14-1.05-.05-1.23.06-1.22.16-1.04.24-.87.32-.71.36-.57.4-.44.42-.33.42-.24.4-.16.36-.1.32-.05.24-.01h.16l.06.01h8.16v-.83H6.18l-.01-2.75-.02-.37.05-.34.11-.31.17-.28.25-.26.31-.23.38-.2.44-.18.51-.15.58-.12.64-.1.71-.06.77-.04.84-.02 1.27.05zm-6.3 1.98l-.23.33-.08.41.08.41.23.34.33.22.41.09.41-.09.33-.22.23-.34.08-.41-.08-.41-.23-.33-.33-.22-.41-.09-.41.09zm13.09 3.95l.28.06.32.12.35.18.36.27.36.35.35.47.32.59.28.73.21.88.14 1.04.05 1.23-.06 1.23-.16 1.04-.24.86-.32.71-.36.57-.4.45-.42.33-.42.24-.4.16-.36.09-.32.05-.24.02-.16-.01h-8.22v.82h5.84l.01 2.76.02.36-.05.34-.11.31-.17.29-.25.25-.31.24-.38.2-.44.17-.51.15-.58.13-.64.09-.71.07-.77.04-.84.01-1.27-.04-1.07-.14-.9-.2-.73-.25-.59-.3-.45-.33-.34-.34-.25-.34-.16-.33-.1-.3-.04-.25-.02-.2.01-.13v-5.34l.05-.64.13-.54.21-.46.26-.38.3-.32.33-.24.35-.2.35-.14.33-.1.3-.06.26-.04.21-.02.13-.01h5.84l.69-.05.59-.14.5-.21.41-.28.33-.32.27-.35.2-.36.15-.36.1-.35.07-.32.04-.28.02-.21V6.07h2.09l.14.01zm-6.47 14.25l-.23.33-.08.41.08.41.23.33.33.23.41.08.41-.08.33-.23.23-.33.08-.41-.08-.41-.23-.33-.33-.23-.41-.08-.41.08z\"/>\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>\n"}},"baseSlug":"/api","routesMapping":{}}