CINXE.COM
/api/v1/payments
<!DOCTYPE html><html lang="en" style="" data-color-mode="system" class=" useReactApp isRefPage "><head><script src="https://cdn.readme.io/public/js/force-firefox-anchor-jump.js?1732290089794"></script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="readme-deploy" content="5.235.0"><meta name="readme-subdomain" content="paytech"><meta name="readme-version" content="1.0"><title>/api/v1/payments</title><meta name="description" content="Get a list of payments sorted by creation date (most recent first)"><meta property="og:title" content="/api/v1/payments"><meta property="og:description" content="Get a list of payments sorted by creation date (most recent first)"><meta property="og:site_name" content="paytech"><meta name="twitter:title" content="/api/v1/payments"><meta name="twitter:description" content="Get a list of payments sorted by creation date (most recent first)"><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://files.readme.io/45785f4-brandmark-blue.svg"><meta name="twitter:image" content="https://files.readme.io/45785f4-brandmark-blue.svg"><link id="favicon" rel="shortcut icon" href="https://paytech.readme.io/favicon.ico" type="image/x-icon"><link rel="canonical" href="https://paytech.readme.io/reference/getpayments"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1732290089794"></script><link data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Dash-ChatGPT-CopilotInstalledPage.e465d3c8429ef097e6ed.css"> <link data-chunk="New" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/New.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.394c4b2f8910cf363781.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.c5ea43d2f4b3b926ff1f.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="routes-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.db8b3beb03eead84c21e.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.a5d24742a3656724b61d.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.766cf20fa350c2c18107.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5548.8fb1bb5d57de6c263c67.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4608.3b5a227647e78e858c3f.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8263.a563779273b90f66c0db.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.a3bb3020bf29f8f67ef8.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.ad57d9fcd570c04fb712.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6722.e485c5aa155bd0f0ccf8.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"> <link data-chunk="core-icons-alert-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"> <link data-chunk="core-icons-more-vertical-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"> <link data-chunk="core-icons-arrow-up-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.002979730c36f9c65ad3.js"> <link data-chunk="core-icons-x-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"> <link data-chunk="core-icons-suggested-edits-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.f0816876bdfbbc06801a.js"> <link data-chunk="core-icons-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="core-icons-eye-off-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2859.94b03b9a9585460aa921.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.5ccfbee71da134a1eeba.js"> <link data-chunk="rmdx" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"> <link data-chunk="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4674.13378da16ce7b5beba66.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.12cee315afa198c8e23e.js"> <link data-chunk="core-icons-trending-up-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"> <link data-chunk="core-icons-callout-info-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.3f125a62ed05cc53aec4.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.cced33af5051de7f473f.js"> <link data-chunk="core-icons-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.js"> <link data-chunk="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.js"> <link data-chunk="core-icons-star-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"> <link data-chunk="core-icons-code-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-code-svg.d29a4cf99a7105e13528.js"> <link data-chunk="core-icons-plus-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-plus-svg.a49fb76ac2661b5e1c7e.js"> <link data-chunk="core-icons-inbox-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-inbox-svg.01c2ecb759e417a98bb8.js"> <link data-chunk="New" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/New.908bc26e77bebc585452.js"> <link data-chunk="core-icons-message-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"> <link data-chunk="core-icons-key-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"> <link data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1231.f80a04007595f4936e51.js"> <link data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Dash-ChatGPT-CopilotInstalledPage.905756735b64839665ac.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.a5d24742a3656724b61d.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.db8b3beb03eead84c21e.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.c5ea43d2f4b3b926ff1f.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.394c4b2f8910cf363781.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="New" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/New.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Dash-ChatGPT-CopilotInstalledPage.e465d3c8429ef097e6ed.css"><!-- CUSTOM CSS--><style title="rm-custom-css">:root{--project-color-primary:#048ef5;--project-color-inverse:#fff;--recipe-button-color:#048ef5;--recipe-button-color-hover:#025491;--recipe-button-color-active:#02375e;--recipe-button-color-focus:rgba(4, 142, 245, 0.25);--recipe-button-color-disabled:#c7e6fe}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#048ef5;--project-color-inverse:#fff}a{color:var(--color-link-primary,#048ef5)}a:hover{color:var(--color-link-primary-darken-5,#025491)}a.text-muted:hover{color:var(--color-link-primary,#048ef5)}.btn.btn-primary{background-color:#048ef5}.btn.btn-primary:hover{background-color:#025491}.theme-line #hub-landing-top h2{color:#048ef5}#hub-landing-top .btn:hover{color:#048ef5}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#048ef5}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#048ef5,#0063ac)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(undefined)}.theme-line header#hub-header #header-top{border-bottom-color:#048ef5}.theme-line header#hub-header #header-top .btn{background-color:#048ef5}header#hub-header #header-top #header-logo{width:40px;height:40px;margin-top:0;background-image:url(https://files.readme.io/97584af-brandmark-white.svg)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#048ef5}#subheader-links a.active{color:#048ef5!important;box-shadow:inset 0 -2px 0 #048ef5}#subheader-links a:hover{color:#048ef5!important;box-shadow:inset 0 -2px 0 #048ef5;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#048ef5}section#hub-discuss .discussion a .discuss-body h4{color:#048ef5}section#hub-discuss .discussion a:hover .discuss-body h4{color:#025491}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#048ef5}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#048ef5}#hub-search-results h3 em{color:#048ef5}.main_background,.tag-item{background:#048ef5!important}.main_background:hover{background:#025491!important}.main_color{color:#048ef5!important}.border_bottom_main_color{border-bottom:2px solid #048ef5}.main_color_hover:hover{color:#048ef5!important}section#hub-discuss h1{color:#048ef5}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#048ef5;background-color:#048ef5}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#025491;border-color:#025491}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#048ef5;color:#048ef5}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#048ef5);border-color:var(--project-color-primary,#048ef5)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#025491;border-color:#025491}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#048ef5;fill:var(--project-color-primary,#048ef5)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#048ef5}.main-color-accent{border-bottom:3px solid #048ef5;padding-bottom:8px}</style><meta name="loadedProject" content="paytech"><script>var storedColorMode = `system` === 'system' ? window.localStorage.getItem('color-scheme') : `system` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.235.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-none theme-solid header-solid header-bg-size-auto header-bg-pos-tl header-overlay-triangles reference-layout-row lumosity-normal hub-full"><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark " style="--color-primary:#048ef5;--color-primary-inverse:#fff;--color-primary-alt:#0063ac;--color-primary-darken-10:#0371c3;--color-primary-darken-20:#025491;--color-primary-alpha-25:rgba(4, 142, 245, 0.25);--color-link-primary:#048ef5;--color-link-primary-darken-5:#047fdc;--color-link-primary-darken-10:#0371c3;--color-link-primary-darken-20:#025491;--color-link-primary-alpha-50:rgba(4, 142, 245, 0.5);--color-link-primary-alpha-25:rgba(4, 142, 245, 0.25);--color-link-background:rgba(4, 142, 245, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><header class="Header3zzata9F_ZPQ rm-Header "><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="/reference" target="_self"><img alt="paytech" class="rm-Logo-img Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/97584af-brandmark-white.svg"/></a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/reference" target="_self"><i class="icon-references NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">API Reference</span></a><div class="NavItem-item1gDDTqaXGhm1 NavItem-item_inactiveMQoyhN045qAn">v<!-- -->1.0</div><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/login?redirect_uri=/reference/getpayments" target="_self" to="/login?redirect_uri=/reference/getpayments">Log In</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="/reference" target="_self"><img alt="paytech" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/97584af-brandmark-white.svg"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-references Header-left-nav-icon10glJKFwewOv"></i>API Reference</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a href="/login?redirect_uri=/reference/getpayments" target="_self" class="Button Button_slate_text Button_md Header-link2tXYTgXq85zW undefined NavItem_mdrYO3ChA2kYvP rm-Header-top-link rm-Header-top-link_login Button_primary">Log In</a></span><div class="ThemeToggle-wrapper1M_iJESXCpGR Dropdown Dropdown_closed"><button aria-label="Toggle to light mode" id="ThemeToggle-button-static-id-placeholder" aria-haspopup="dialog" class="Button Button_slate_text Button_sm rm-ThemeToggle ThemeToggle2tVPbUyQbWDo Dropdown-toggle Button_primary" type="button"><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv " role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Moon (Dark Mode)</title><path d="M19 14.79C18.8427 16.4922 18.2039 18.1144 17.1582 19.4668C16.1126 20.8192 14.7035 21.8458 13.0957 22.4265C11.4879 23.0073 9.74798 23.1181 8.0795 22.7461C6.41102 22.3741 4.88299 21.5345 3.67423 20.3258C2.46546 19.117 1.62594 17.589 1.25391 15.9205C0.881876 14.252 0.992717 12.5121 1.57346 10.9043C2.1542 9.29651 3.18083 7.88737 4.53321 6.84175C5.8856 5.79614 7.5078 5.15731 9.21 5C8.21341 6.34827 7.73385 8.00945 7.85853 9.68141C7.98322 11.3534 8.70386 12.9251 9.8894 14.1106C11.0749 15.2961 12.6466 16.0168 14.3186 16.1415C15.9906 16.2662 17.6517 15.7866 19 14.79Z"></path><path class="ThemeToggle-Icon-star3wweJby1gM4w" d="M18.3707 1C18.3707 3.22825 16.2282 5.37069 14 5.37069C16.2282 5.37069 18.3707 7.51313 18.3707 9.74138C18.3707 7.51313 20.5132 5.37069 22.7414 5.37069C20.5132 5.37069 18.3707 3.22825 18.3707 1Z"></path></svg><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv ThemeToggle-Icon_active18I2-19CkbgD" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Sun (Light Mode)</title><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 1V3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 5.64L19.78 4.22"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M21 12H23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 18.36L19.78 19.78"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 21V23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 19.78L5.64 18.36"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M1 12H3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 4.22L5.64 5.64"></path><path d="M12 17C14.7614 17 17 14.7614 17 12C17 9.23858 14.7614 7 12 7C9.23858 7 7 9.23858 7 12C7 14.7614 9.23858 17 12 17Z"></path></svg></button></div><div class="Header-searchtb6Foi0-D9Vx"><button aria-label="Search" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div></button></div></div></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav class="Header-leftADQdGVqx1wqU"><span class="undefined NavItem_inactive1YE6SGanIJp5 rm-Header-bottom-link">v<!-- -->1.0</span><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/reference" target="_self"><i class="icon-references"></i><span>API Reference</span></a></nav><button align="center" justify="between" style="--flex-gap:var(--xs)" class="Button Button_sm Flex Flex_row MobileSubnav1DsTfasXloM2 Button_contrast Button_contrast_outline" type="button"><span class="Button-label">/api/v1/payments</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-up-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 16 6 6 6-6M18 8l-6-6-6 6" class="icon-stroke-width"></path></svg></span></button><div class="rm-Header-search Header-searchtb6Foi0-D9Vx rm-Header-search_feather Header-search_featherYsmQBn55F3d9"><button aria-label="Search" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div><div class="Header-search-placeholder3Vx4OmMPcjAi rm-SearchToggle-placeholder">Search</div><div class="rm-SearchToggle-shortcut"></div></button></div></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop show-modal rm-SearchModal" role="button" tabindex="0"></div></div></div></header><main class="rm-ReferenceMain rm-Container rm-Container_flex loading" id="Explorer"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj" id="reference-sidebar"><div class="Main-QuickNav-container1OiLvjSDusO6"><button aria-keyshortcuts="Control+/ Meta+/" class="QuickNav1q-OoMjiX_Yr QuickNav-button2KzlQbz5Pm2Y">JUMP TO</button></div><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">pay.tech API</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getpayments"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Payment" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Payment</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link active" target="_self" href="/reference/getpayments"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">/api/v1/payments</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/createpayment"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">/api/v1/payments</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpayment"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">/api/v1/payments/{id}</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getoperations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">/api/v1/payments/{id}/operations</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/webhooks"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Webhooks</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/error-codes"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Error Codes</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/test-cards"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Test Cards</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getsubscription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Subscription" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Subscription</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getsubscription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">/api/v1/subscriptions/{id}</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/patchsubscription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">/api/v1/subscriptions/{id}</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_patch Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">patch</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/reference/google-pay"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Google Pay™</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/reference/apple-pay"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Apple Pay</span></span></a></li></ul></section><div class="readme-logo" id="readmeLogo">Powered by <a aria-label="ReadMe" href="https://readme.com?ref_src=hub&project=paytech" style="color:unset"><i class="icon icon-readme" style="display:inline-block;min-width:71px"></i></a></div></div></nav><article class="rm-Article" id="content"><header class="headline-container21aRBSn8Bqg6 " data-raycast-oas="[object Object]"><div class="headline-container-grid-itemGdPV-VbhShYs button-containerobFfV0vf6giV"><div class="reference-flyout"><button aria-label="Toggle reference sidebar" class="icon-menu reference-sidebar-mobile-button26mqim6Chewq " type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj mobile" id="reference-sidebar"><div class="ref-QuickNav-mobile-containerARtvyEDVpRhW"><button aria-keyshortcuts="Control+/ Meta+/" class="QuickNav1q-OoMjiX_Yr QuickNav-button2KzlQbz5Pm2Y">JUMP TO</button></div><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">pay.tech API</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getpayments"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Payment" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Payment</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link active" target="_self" href="/reference/getpayments"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">/api/v1/payments</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/createpayment"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">/api/v1/payments</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpayment"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">/api/v1/payments/{id}</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getoperations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">/api/v1/payments/{id}/operations</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/webhooks"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Webhooks</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/error-codes"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Error Codes</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/test-cards"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Test Cards</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getsubscription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Subscription" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Subscription</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getsubscription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">/api/v1/subscriptions/{id}</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/patchsubscription"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">/api/v1/subscriptions/{id}</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_patch Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">patch</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/reference/google-pay"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Google Pay™</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/reference/apple-pay"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Apple Pay</span></span></a></li></ul></section><div class="readme-logo" id="readmeLogo">Powered by <a aria-label="ReadMe" href="https://readme.com?ref_src=hub&project=paytech" style="color:unset"><i class="icon icon-readme" style="display:inline-block;min-width:71px"></i></a></div></div></nav></div></div></div><header id="content-head"><h1>/api/v1/payments<div class="rm-TagTooltip undefined Dropdown Dropdown_closed"><button aria-label="View tags" aria-haspopup="dialog" class="Button Button_xs undefined TagTooltip-tag-button1aNfFPfIiBpt icon-versions-2 Dropdown-toggle Button_minimum Button_minimum_text Button_uppercase" type="button"></button></div></h1></header></div><div class="headline-container-article-info2GaOf2jMpV0r"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get headline-container-api-method1Hc-Fm7uaccR" data-testid="http-method">get</span> <span class="headline-container-article-info-url2nV_XrjpFuVQ" data-testid="serverurl" title="https://engine-sandbox.pay.tech/api/v1/payments">https://engine-sandbox.pay.tech<!-- -->/api/v1/payments</span></div><div role="doc-subtitle" class="rm-Markdown markdown-body undefined excerptT2m-MzSJGRK7" data-testid="RDMD"><p>Get a list of payments sorted by creation date (most recent first)</p></div></header><div class="ModalWrapper" id="response-schema-modal-target"></div></article><div id="ReferencePlayground" class="rm-Playground PlaygroundC7DInM9NFvBg "><section class="Playground-section3VTXuaYZivJK " data-notranslate="true"><header class="APISectionHeader3LN_-QIR0m7x rm-APISectionHeader"><div class="APISectionHeader-heading4MUMLbp4_nLs">Language</div></header><div class="LanguagePickerSIxXDuYmeYsW rm-LanguagePicker"><div class="LanguagePicker-languages1qVVo_v6AlP9"><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton_active rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-curl"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>Shell</button><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-node"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>Node</button><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-ruby"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>Ruby</button><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-php"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>PHP</button><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-python"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>Python</button><div class="LanguagePicker-divider Dropdown Dropdown_closed"><button aria-label="More Languages" aria-haspopup="dialog" class="Button Button_md LanguagePicker-more2w3Eqm0IH_K7 rm-LanguageButton-more Dropdown-toggle Button_primary_ghost Button_primary" type="button"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="more-vertical" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-label="More ellipsis"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M12 13a1 1 0 1 0 0-2 1 1 0 0 0 0 2ZM12 6a1 1 0 1 0 0-2 1 1 0 0 0 0 2ZM12 20a1 1 0 1 0 0-2 1 1 0 0 0 0 2Z" class="icon-stroke-width"></path></svg></span></button></div></div></div></section><section class="Playground-section3VTXuaYZivJK " data-notranslate="true"><section class="APIAuth rm-APIAuth" data-testid="api-auth"><header class="APISectionHeader3LN_-QIR0m7x rm-APISectionHeader"><div class="APISectionHeader-heading4MUMLbp4_nLs">Credentials<i aria-label="Information" class="InfoPop-helpIconrmWTyT_Hj2Cl icon-help-circle undefined" role="button"></i></div><div><div class="Info-infoBadge3luOwOnjfNiR Info-infoBadge_tooltip24vnuq69qR2X" role="button" tabindex="0"><div>Bearer</div><i aria-label="Information" class="Info-infoBadge-icon1VOz2gcy65SK icon-info1" role="img"></i></div></div></header><section align="stretch" class="Flex Flex_row InputGroup " justify="between" style="--flex-gap:var(--xs)"><header align="start" class="Flex Flex_row InputGroup-dropdown-parent" justify="between" style="--flex-gap:var(--xs)"><div class="InputGroup-dropdown Dropdown Dropdown_closed"><button class="Button Button_sm InputGroup-button Dropdown-toggle" data-testid="api-auth-security-button" disabled="" aria-haspopup="dialog"><span>Bearer</span></button></div></header><div class="InputGroup-input-parent "><div class="InputGroup-dropdown-inputs "><input type="text" autoComplete="off" class="InputGroup-input " id="APIAuth-token" placeholder="token" required="" spellcheck="false" value=""/><button aria-label="Hide" class="Button Button_xs rm-APIAuth-lock undefined Button_minimum Button_minimum_text Button_uppercase" type="button"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="lock" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M19 11H5a2 2 0 0 0-2 2v7a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2v-7a2 2 0 0 0-2-2ZM7 11V7a5 5 0 1 1 10 0v4" class="icon-stroke-width"></path></svg></span></button></div></div></section></section></section><section class="Playground-section3VTXuaYZivJK " data-notranslate="true"><header class="APISectionHeader3LN_-QIR0m7x rm-APISectionHeader"><div class="APISectionHeader-heading4MUMLbp4_nLs">URL</div></header><div class="ServerVars InputGroup"><div class="Dropdown Dropdown_closed"><button class="InputGroup-button Dropdown-toggle" type="button" aria-haspopup="dialog"><span>Base URL</span><span class="icon-chevron-down"></span></button></div><button class="InputGroup-input ServerVars-url" data-testid="serverurl" disabled=""><span>https://engine-sandbox.pay.tech</span><span class="ServerText-endpoint" data-testid="url-endpoint">/api/v1/payments</span></button></div></section><section class="Playground-section3VTXuaYZivJK Playground-section_sticky_fBLN0qIkmEd " data-notranslate="true"><section class="APIResponse3FBSi0-qfTQs rm-PlaygroundResponse"><header align="center" class="Flex Flex_row APIResponse-header3Y3zkft15LCF" justify="between" style="--flex-gap:var(--md)"><div><button class="Button Button_xs APIResponse-header-tab31M7P70x-CKu APIResponse-header-tab-active36LB45PMYTuB APIResponse-header-tab-disabled_gfqRzz9FpgZ Button_minimum_ghost Button_minimum Button_uppercase" disabled="" type="button">RESPONSE</button></div></header><div align="center" class="Flex Flex_col APIResponse-empty3Qdzfpq_JjNF" justify="between" style="--flex-gap:var(--md)"><div>Click <code class="APIResponse-empty-tryit2H55vIRfRhS3">Try It!</code> to start a request and see the response here!</div></div></section></section></div><div class="ModalWrapper" id="response-headers-modal-root"></div><div class="ModalWrapper" id="tutorialmodal-root"></div><div class="ModalWrapper QuickNav-modal QuickNav-modal-desktop" id="QuickNav-modal-root"></div><div class="ModalWrapper QuickNav-modal QuickNav-modal-mobile" id="QuickNav-mobile-modal-root"></div></main><footer aria-label="Status banner" class="AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div><div class="ng-non-bindable"><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[],"refs":[{"_id":"652d4585ae93b308d03f6746","title":"pay.tech API","slug":"paytech-api","order":9999,"reference":true,"project":"652d419afbead3005749f584","version":"652d419bfbead3005749f58f","createdAt":"2023-10-16T14:15:33.911Z","__v":0,"pages":[{"_id":"652d4586ae93b308d03f6748","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"652d4585ae93b308d03f6744"},"title":"Payment","icon":"","type":"basic","slug":"payment","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Payment","link_url":"","link_external":false,"previousSlug":"","category":"652d4585ae93b308d03f6746","createdAt":"2023-10-16T14:15:34.768Z","isBodyEmpty":true,"children":[{"_id":"652d4587ae93b308d03f674c","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"652d4585ae93b308d03f6744"},"title":"/api/v1/payments","icon":"","type":"endpoint","slug":"getpayments","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getPayments","link_url":"","link_external":false,"previousSlug":"","category":"652d4585ae93b308d03f6746","createdAt":"2023-10-16T14:15:35.204Z","parentDoc":"652d4586ae93b308d03f6748","isBodyEmpty":true,"children":[]},{"_id":"652d4587ae93b308d03f674d","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"652d4585ae93b308d03f6744"},"title":"/api/v1/payments","icon":"","type":"endpoint","slug":"createpayment","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"createPayment","link_url":"","link_external":false,"previousSlug":"","category":"652d4585ae93b308d03f6746","createdAt":"2023-10-16T14:15:35.205Z","parentDoc":"652d4586ae93b308d03f6748","isBodyEmpty":true,"children":[]},{"_id":"652d4587ae93b308d03f674e","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"652d4585ae93b308d03f6744"},"title":"/api/v1/payments/{id}","icon":"","type":"endpoint","slug":"getpayment","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getPayment","link_url":"","link_external":false,"previousSlug":"","category":"652d4585ae93b308d03f6746","createdAt":"2023-10-16T14:15:35.206Z","parentDoc":"652d4586ae93b308d03f6748","isBodyEmpty":true,"children":[]},{"_id":"652d4587ae93b308d03f674f","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"652d4585ae93b308d03f6744"},"title":"/api/v1/payments/{id}/operations","icon":"","type":"endpoint","slug":"getoperations","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getOperations","link_url":"","link_external":false,"previousSlug":"","category":"652d4585ae93b308d03f6746","createdAt":"2023-10-16T14:15:35.207Z","parentDoc":"652d4586ae93b308d03f6748","isBodyEmpty":true,"children":[]},{"_id":"652d46cd508192086e70ac69","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Webhooks","icon":"","type":"basic","slug":"webhooks","order":999,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"652d4586ae93b308d03f6748","category":"652d4585ae93b308d03f6746","createdAt":"2023-10-16T14:21:01.252Z","isBodyEmpty":false,"children":[]},{"_id":"652d474f43d010099214a767","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Error Codes","icon":"","type":"basic","slug":"error-codes","order":999,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"652d4586ae93b308d03f6748","category":"652d4585ae93b308d03f6746","createdAt":"2023-10-16T14:23:11.894Z","isBodyEmpty":false,"children":[]},{"_id":"652d477f954bcf0aa1d3b4c2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Test Cards","icon":"","type":"basic","slug":"test-cards","order":999,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"652d4586ae93b308d03f6748","category":"652d4585ae93b308d03f6746","createdAt":"2023-10-16T14:23:59.397Z","isBodyEmpty":false,"children":[]}]},{"_id":"652d4586ae93b308d03f6749","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"652d4585ae93b308d03f6744"},"title":"Subscription","icon":"","type":"basic","slug":"subscription","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Subscription","link_url":"","link_external":false,"previousSlug":"","category":"652d4585ae93b308d03f6746","createdAt":"2023-10-16T14:15:34.770Z","isBodyEmpty":true,"children":[{"_id":"652d4587ae93b308d03f6750","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"652d4585ae93b308d03f6744"},"title":"/api/v1/subscriptions/{id}","icon":"","type":"endpoint","slug":"getsubscription","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getSubscription","link_url":"","link_external":false,"previousSlug":"","category":"652d4585ae93b308d03f6746","createdAt":"2023-10-16T14:15:35.207Z","parentDoc":"652d4586ae93b308d03f6749","isBodyEmpty":true,"children":[]},{"_id":"652d4587ae93b308d03f6751","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"652d4585ae93b308d03f6744"},"title":"/api/v1/subscriptions/{id}","icon":"","type":"endpoint","slug":"patchsubscription","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patchSubscription","link_url":"","link_external":false,"previousSlug":"","category":"652d4585ae93b308d03f6746","createdAt":"2023-10-16T14:15:35.208Z","parentDoc":"652d4586ae93b308d03f6749","isBodyEmpty":true,"children":[]}]},{"_id":"66d05a5fbe0bef004c73ebb4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Google Pay™","icon":"","type":"basic","slug":"google-pay","order":999,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"652d4585ae93b308d03f6746","createdAt":"2024-08-29T11:24:15.524Z","isBodyEmpty":false,"children":[]},{"_id":"671b7deddc4900006aadba89","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Apple Pay","icon":"","type":"basic","slug":"apple-pay","order":999,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"652d4585ae93b308d03f6746","createdAt":"2024-10-25T11:15:57.433Z","isBodyEmpty":false,"children":[]}]}]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"ZWExZjlkYzAyMjIzMzE5YTJlYzI4YjE0OGRjN2I0MGNmMDkwZGViMDE3ZWM4MTQzMTQ1ZDM3YTM0NDE3ODFjZHRhZ0ZpbHRlcnM9KHByb2plY3Q6NjUyZDQxOWFmYmVhZDMwMDU3NDlmNTg0KSwodmVyc2lvbjpub25lLHZlcnNpb246NjUyZDQxOWJmYmVhZDMwMDU3NDlmNThmKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":false,"docs":false,"examples":false,"reference":true,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false},"id":"652d419afbead3005749f584","name":"paytech","subdomain":"paytech","subpath":"","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","recipes":"","tutorials":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"paytech"},"version":"1.0"}},"doc":{"metadata":{"image":[],"title":"","description":"","keywords":"","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"652d4585ae93b308d03f6744"},"swagger":{"path":"/api/v1/payments"},"next":{"description":"","pages":[]},"algolia":{"recordCount":1,"publishPending":false,"translationFailure":false,"updatedAt":"2023-10-16T14:15:35.377Z"},"title":"/api/v1/payments","icon":"","updates":[],"type":"endpoint","slug":"getpayments","excerpt":"Get a list of payments sorted by creation date (most recent first)","body":"","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getPayments","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"","slugUpdatedAt":"2023-10-16T07:13:42.459Z","revision":3,"_id":"652d4587ae93b308d03f674c","category":{"title":"pay.tech API","slug":"paytech-api","order":9999,"reference":true,"_id":"652d4585ae93b308d03f6746","project":"652d419afbead3005749f584","version":"652d419bfbead3005749f58f","createdAt":"2023-10-16T14:15:33.911Z","__v":0,"type":"reference","id":"652d4585ae93b308d03f6746"},"createdAt":"2023-10-16T14:15:35.204Z","updatedAt":"2023-10-16T14:15:35.204Z","parentDoc":"652d4586ae93b308d03f6748","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["652d419bfbead3005749f591","652d419bfbead3005749f591","652d419bfbead3005749f593","652d4585ae93b308d03f6746"],"pdfStatus":"","_id":"652d419bfbead3005749f58f","project":"652d419afbead3005749f584","releaseDate":"2023-10-16T13:58:51.334Z","createdAt":"2023-10-16T13:58:51.351Z","updatedAt":"2023-10-16T14:15:33.913Z","__v":1},"project":"652d419afbead3005749f584","__v":1,"lastUpdatedHash":"2d96be2fa4b53b4a3b5ccf5496662903d866dbc4","isApi":true,"tutorials":[],"id":"652d4587ae93b308d03f674c"},"glossaryTerms":[{"_id":"652d419afbead3005749f585","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"hideTOC":false,"loginUrl":"https://dash.readme.com/to/paytech","meta":{"_id":"652d4587ae93b308d03f674c","description":"Get a list of payments sorted by creation date (most recent first)","hidden":false,"image":[],"keywords":"","metaTitle":"/api/v1/payments","parent":"652d4586ae93b308d03f6748","robots":"index","slug":"getpayments","title":"/api/v1/payments","type":"reference"},"oasDefinition":{"openapi":"3.0.1","info":{"title":"pay.tech API","description":"Payment API\n","contact":{"name":"Support","email":"support@pay.tech"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"version":""},"servers":[{"url":"https://engine-sandbox.pay.tech","description":"Sandbox"},{"url":"https://engine.pay.tech","description":"Production"}],"tags":[{"name":"Payment","description":"Merchant Payments API"},{"name":"Subscription","description":"Recurring Subscription API"},{"name":"Webhooks","description":"In order to receive webhooks from our system you need to specify 'Webhook Url' in shop settings or provide 'webhookUrl' parameter in createPayment request. The request parameter takes precedence over the parameter specified in shop settings.<br/><br/>\nTo ensure that webhooks come from our system, you can generate a Signing Key in your shop settings. If the Signing Key is specified, webhooks from our system will include 'Signature' header with HMAC-SHA256 hash generated from JSON body and Signing Key.<br/>\n<SchemaDefinition schemaRef=\"#/components/schemas/Result\" />\n"},{"name":"Sandbox","description":"For a successful deposit in the sandbox environment, the amount should be less than 10000000. For test withdrawals and refunds, the limit is 10000.\n### Test cards\n| Card Number | Result |\n|---------------------|----------------------------------------------------------------|\n| 4000 0000 0000 0002 | 3D-Secure enrolled, successful authorization |\n| 4242 4242 4242 4242 | 3D-Secure enrolled, declined authorization |\n| 4000 0000 0000 0408 | Not enrolled for 3D-Secure, successful authorization |\n| 4000 0000 0000 0416 | Not enrolled for 3D-Secure, declined authorization |\n"},{"name":"Error Codes","description":"| Code | Description |\n|------|-------------------------------------------------------------------------------|\n| 1.00 | Illegal Workflow State |\n| 1.01 | Not Found |\n| 1.02 | Communication Problem |\n| 1.03 | Internal Server Error |\n| 1.04 | Cancelled by Timeout |\n| 1.05 | Terminal not Found |\n| 1.06 | Recurring Token not Found |\n| 1.07 | Payer Unaccepted |\n| 1.08 | Invalid Amount |\n| 1.09 | Invalid Currency |\n| 2.00 | Cancelled by Customer |\n| 3.00 | Declined by Acquirer |\n| 3.01 | Declined by Acquirer: Anti-fraud |\n| 3.02 | Declined by Acquirer: Request Validation |\n| 3.03 | Acquirer Malfunction |\n| 3.04 | Acquirer Timeout |\n| 3.05 | Acquirer Limits Reached |\n| 3.06 | Declined by Acquirer: Card Scheme |\n| 3.07 | Declined by Acquirer: Card Data |\n| 3.08 | Declined by Acquirer: Business Rules |\n| 3.09 | Not Fully 3DS |\n| 3.10 | Unknown Error Code |\n| 3.11 | Payer cannot pay |\n| 3.12 | Invalid ID Document |\n| 3.13 | ID Document Restrictions |\n| 3.14 | Declined Due to Age Requirements |\n| 3.15 | ID Document Under Temporary Restrictions |\n| 4.00 | Declined by Issuer |\n| 4.01 | Insufficient Funds |\n| 4.02 | Do Not Honor |\n| 4.03 | Declined by Issuer: Invalid Card Number |\n| 4.04 | Declined by Issuer: Expired Card |\n| 4.05 | Issuer Limits Reached |\n| 4.06 | Card Lost or Stolen |\n| 4.07 | Invalid Security Code |\n| 4.08 | Declined by Issuer: Business Rules |\n| 5.00 | Declined by 3DS |\n| 5.01 | 3DS Timeout |\n| 6.00 | Declined by Internal Anti-fraud |\n| 6.01 | Card PAN Blacklisted |\n| 6.02 | Customer Email Blacklisted |\n| 6.03 | Card Issuing Country Restricted |\n| 6.04 | IP Country Restricted |\n| 6.05 | Restricted Currency |\n| 6.06 | Invalid Amount |\n| 6.07 | IP Country Must Be Equal to Billing Country |\n| 6.08 | IP Country Must Be Equal to Card Issuing Country |\n| 6.09 | Billing Country Must Be Equal to Card Issuing Country |\n| 6.10 | Payment Created Within Closed Period of Day |\n| 6.11 | Card PAN not Whitelisted |\n| 6.12 | Cardholder name is invalid |\n| 6.13 | The same card is used by different customers |\n| 6.14 | Customer Phone Blacklisted |\n| 6.21 | Limit exceeded: Number of completed deposits |\n| 6.22 | Limit exceeded: Number of completed deposits for card |\n| 6.23 | Limit exceeded: Number of declined deposits for card |\n| 6.24 | Limit exceeded: Number of cards for IP address |\n| 6.25 | Limit exceeded: Number of IP addresses for card |\n| 6.26 | Limit exceeded: IP country does not match card country |\n| 6.27 | Limit exceeded: Same amount and currency for card |\n| 6.28 | Limit exceeded: Amount of deposits in specified currency |\n| 6.29 | Limit exceeded: Amount of deposits for card and currency |\n| 6.30 | Limit exceeded: Amount of deposits in base currency |\n| 6.31 | Limit exceeded: Amount of deposits for card in base currency |\n| 6.32 | Limit exceeded: Number of IP countries for card |\n| 6.33 | Limit exceeded: Amount of deposits for customer in base currency |\n| 6.34 | Limit exceeded: Withdrawal amount for customer in base currency |\n| 7.00 | Declined by External Anti-fraud |\n| 7.01 | External Anti-fraud Communication Problem |\n"}],"paths":{"/api/v1/payments":{"get":{"tags":["Payment"],"description":"Get a list of payments sorted by creation date (most recent first)","operationId":"getPayments","parameters":[{"name":"offset","in":"query","description":"The number of items to skip before starting to collect the result set. Default is 0.","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000}},{"name":"limit","in":"query","description":"The numbers of items to return. Default is 50.","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"created.gte","in":"query","description":"If passed, return only payments created at or after the specified time","required":false,"schema":{"type":"string","format":"ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)","example":"2021-10-13T10:26:18"}},{"name":"created.lt","in":"query","description":"If passed, return only payments created strictly before the specified time","required":false,"schema":{"type":"string","format":"ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)","example":"2021-10-13T10:39:34"}},{"name":"updated.gte","in":"query","description":"If passed, return only payments updated at or after the specified time","required":false,"schema":{"type":"string","format":"ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)","example":"2021-10-13T10:26:18"}},{"name":"updated.lt","in":"query","description":"If passed, return only payments updated strictly before the specified time","required":false,"schema":{"type":"string","format":"ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)","example":"2021-10-13T10:39:34"}}],"responses":{"200":{"description":"Payment List Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentListResponse"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}}},"security":[{"bearerAuthentication":[]}]},"post":{"tags":["Payment"],"description":"Payment request, used for DEPOSITS, WITHDRAWALS and REFUNDS","operationId":"createPayment","requestBody":{"description":"Payment Request - Request to initiate a payment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}},"required":true},"responses":{"200":{"description":"Payment response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResponse"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}}},"security":[{"bearerAuthentication":[]}],"x-codegen-request-body-name":"body"}},"/api/v1/payments/{id}":{"get":{"tags":["Payment"],"description":"Find Payment by Id","operationId":"getPayment","parameters":[{"name":"id","in":"path","description":"Payment Id","required":true,"schema":{"pattern":"/[a-zA-Z0-9]{32}/","type":"string"}}],"responses":{"200":{"description":"Payment Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResponse"}}}},"401":{"description":"Invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bearerAuthentication":[]}],"x-codegen-request-body-name":"body"}},"/api/v1/payments/{id}/operations":{"get":{"tags":["Payment"],"description":"Get a list of operations performed during payment processing sorted by time (most recent first)","operationId":"getOperations","parameters":[{"name":"id","in":"path","description":"Payment Id","required":true,"schema":{"pattern":"/[a-zA-Z0-9]{32}/","type":"string"}}],"responses":{"200":{"description":"Operation List Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationListResponse"}}}},"401":{"description":"Invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bearerAuthentication":[]}],"x-codegen-request-body-name":"body"}},"/api/v1/subscriptions/{id}":{"get":{"tags":["Subscription"],"description":"Find Subscription by Id","operationId":"getSubscription","parameters":[{"name":"id","in":"path","description":"Subscription Id","required":true,"schema":{"pattern":"/[a-zA-Z0-9]{32}/","type":"string"}}],"responses":{"200":{"description":"Subscription Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}}},"401":{"description":"Invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"404":{"description":"Subscription not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bearerAuthentication":[]}],"x-codegen-request-body-name":"body"},"patch":{"tags":["Subscription"],"description":"Patch Subscription","operationId":"patchSubscription","parameters":[{"name":"id","in":"path","description":"Subscription Id","required":true,"schema":{"pattern":"/[a-zA-Z0-9]{32}/","type":"string"}}],"requestBody":{"description":"Subscription patch request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionPatchRequest"}}},"required":true},"responses":{"200":{"description":"Subscription Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}}},"401":{"description":"Invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"404":{"description":"Subscription not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bearerAuthentication":[]}],"x-codegen-request-body-name":"body"}}},"components":{"schemas":{"PaymentMethodDetails":{"type":"object","properties":{"customerAccountNumber":{"maxLength":256,"type":"string","description":"Customer account Id in external system or masked card PAN","example":"400000***0002"},"cardholderName":{"maxLength":128,"type":"string","description":"Cardholder name (for BASIC_CARD payment method only)","example":"John Doe"},"cardExpiryMonth":{"minLength":2,"maxLength":2,"type":"string","description":"Card expiration month (for BASIC_CARD payment method only)","example":"01"},"cardExpiryYear":{"minLength":4,"maxLength":4,"type":"string","description":"Card expiration year (for BASIC_CARD payment method only)","example":"2023"}}},"BillingAddress":{"type":"object","properties":{"addressLine1":{"maxLength":50,"type":"string","description":"Line 1 of the address (e.g., Number, street, etc)","example":"7, Sunny street"},"addressLine2":{"maxLength":50,"type":"string","description":"Line 2 of the address (e.g., Suite, apt)","example":"Office 3"},"city":{"maxLength":50,"type":"string","description":"City name","example":"Limassol"},"countryCode":{"maxLength":2,"minLength":2,"pattern":"[A-Z]{2}","type":"string","description":"2-character IS0-3166-1 country code","example":"CY"},"postalCode":{"maxLength":12,"type":"string","description":"Postal code","example":"4141"},"state":{"maxLength":40,"type":"string","description":"State code","example":"CA"}},"description":"Customer's billing address"},"Card":{"type":"object","properties":{"cardNumber":{"maxLength":23,"type":"string","description":"Card primary account number (PAN). All non-numeric characters will be ignored.","example":"4000 0000 0000 0002"},"cardholderName":{"maxLength":128,"type":"string","description":"Cardholder's name printed on the card","example":"John Smith"},"cardSecurityCode":{"minLength":3,"maxLength":4,"type":"string","description":"Card security code (CVV2 / CVC2 / CAV2)","example":"010"},"expiryMonth":{"minLength":2,"maxLength":2,"type":"string","description":"Card expiration month, 2 digits","example":"01"},"expiryYear":{"minLength":4,"maxLength":4,"type":"string","description":"Card expiration year, 4 digits","example":"2030"}},"description":"You must be PCI DSS compliant to collect card data on your side. If you are not certified, do not add this field to your request and we will collect the data on our page."},"Customer":{"type":"object","properties":{"referenceId":{"maxLength":128,"type":"string","description":"Id of the customer assigned by Merchant","example":"customer_123"},"citizenshipCountryCode":{"maxLength":2,"minLength":2,"type":"string","description":"Customer country of citizenship","example":"AU"},"firstName":{"maxLength":128,"type":"string","example":"John"},"lastName":{"maxLength":128,"type":"string","example":"Smith"},"dateOfBirth":{"maxLength":10,"minLength":10,"type":"string","format":"ISO 8601 (YYYY-MM-DD)","example":"2001-12-03"},"email":{"maxLength":256,"type":"string","description":"Email address of the customer","format":"email","example":"my@email.com"},"phone":{"maxLength":18,"type":"string","description":"International phone number of the customer, without the '+'. Use a space as a separator between the dialing country code and local phone number.","example":"357 123123123"},"locale":{"maxLength":2,"minLength":2,"type":"string","description":"Customer preferred display language","example":"ru"},"accountNumber":{"maxLength":256,"type":"string","description":"Customer account number in the provider's system. Used for some types of withdrawals."},"accountName":{"maxLength":64,"type":"string","description":"Customer account name in the provider's system. Used for some types of withdrawals."},"bank":{"maxLength":64,"type":"string","description":"Customer bank. Used for some types of withdrawals."},"bankBranch":{"maxLength":64,"type":"string","description":"Customer bank branch. Used for some types of withdrawals."},"documentType":{"maxLength":16,"type":"string","description":"Type of identification document of the customer"},"documentNumber":{"maxLength":64,"type":"string","description":"An identifier for the customer assigned by a government authority"},"routingGroup":{"maxLength":64,"type":"string","description":"Identify the customer as belonging to a specific group that is used for routing","example":"VIP"},"kycStatus":{"type":"boolean","description":"Indicates whether the customer has passed KYC verification","example":true},"paymentInstrumentKycStatus":{"type":"boolean","description":"Indicates whether the payment instrument (usually the card number) has passed KYC verification","example":true},"dateOfFirstDeposit":{"type":"string","format":"ISO 8601 (YYYY-MM-DD)","description":"Date of the first deposit from the customer","example":"2021-01-01"},"depositsAmount":{"type":"integer","description":"How much the customer has deposited, in base currency","example":5000},"withdrawalsAmount":{"type":"integer","description":"How much the customer has withdrawn, in base currency","example":1000},"depositsCnt":{"type":"integer","description":"How many times the customer made a deposit","example":5000},"withdrawalsCnt":{"type":"integer","description":"How many times the customer made a withdrawal","example":1000}}},"SubscriptionRequest":{"required":["frequency"],"type":"object","properties":{"description":{"maxLength":512,"type":"string","description":"Description for subsequent recurring payments","example":"Subscription to service"},"amount":{"type":"number","description":"The amount to be used for subsequent payments. If not specified, the amount of the original payment is used.","example":99.99},"startTime":{"type":"string","format":"ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)","description":"Date and time of the 1st cycle. if not specified, then calculated as (initialDeposit.createTime + frequency*frequencyUnit).","example":"2030-12-25T10:11:12"},"frequency":{"type":"integer","minimum":1,"description":"The number of intervals after which a subscriber is billed. For example, if the frequencyUnit is DAY with an frequency of 2, the subscription is billed once every two days.","example":2},"frequencyUnit":{"type":"string","description":"The interval at which the subscription is billed. Use 'MINUTE' for testing purposes only.","example":"DAY","enum":["MINUTE","DAY","WEEK","MONTH"]},"numberOfCycles":{"type":"integer","minimum":1,"description":"Required number of subsequent recurring payments. Unlimited if value is not specified.","example":12},"retryStrategy":{"$ref":"#/components/schemas/SubscriptionRetryStrategy"}},"description":"Subscription to bill customers at regular intervals. Used only with 'startRecurring=true'."},"SubscriptionPatchRequest":{"type":"object","properties":{"state":{"type":"string","description":"New subscription state","example":"CANCELLED","enum":["CANCELLED"]}}},"SubscriptionResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"ISO 8601","example":"2020-10-07T13:36:32.595Z"},"status":{"type":"integer","description":"HTTP status code","example":200},"result":{"$ref":"#/components/schemas/Subscription"}}},"Subscription":{"type":"object","properties":{"id":{"maxLength":32,"type":"string","description":"Subscription Id"},"customerReferenceId":{"maxLength":128,"type":"string","description":"Id of the customer from initial payment"},"description":{"maxLength":512,"type":"string","description":"Description for subsequent recurring payments","example":"Subscription to service"},"amount":{"type":"number","description":"The amount to be used for subsequent payments"},"currency":{"type":"string","description":"Payment currency","format":"ISO 4217 code for FIAT currencies or cryptocurrency symbol"},"createTime":{"type":"string","format":"ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)","description":"Date and time the subscription was created","example":"2030-12-25T10:11:12"},"startTime":{"type":"string","format":"ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)","description":"Date and time of the 1st cycle","example":"2030-12-25T10:11:12"},"frequency":{"type":"integer","minimum":1,"description":"The number of intervals after which a subscriber is billed. For example, if the frequencyUnit is DAY with an frequency of 2, the subscription is billed once every two days.","example":2},"frequencyUnit":{"type":"string","description":"The interval at which the subscription is billed. Use 'MINUTE' for testing purposes only.","example":"DAY","enum":["MINUTE","DAY","WEEK","MONTH"]},"requestedNumberOfCycles":{"type":"integer","minimum":1,"description":"Required number of subsequent recurring payments. Unlimited if value is not specified.","example":12},"state":{"type":"string","description":"Subscription state","example":"ACTIVE","enum":["ACTIVE","CANCELLED","COMPLETED"]},"recurringToken":{"type":"string","description":"Token that is used to continue the recurring chain"},"retryStrategy":{"$ref":"#/components/schemas/SubscriptionRetryStrategy"},"cycles":{"type":"array","description":"List of payments automatically generated for this subscription","items":{"$ref":"#/components/schemas/SubscriptionCycle"}}}},"SubscriptionCycle":{"type":"object","properties":{"sequence":{"type":"integer","description":"Sequence number of the cycle"},"type":{"type":"string","description":"Cycle type","example":"REGULAR","enum":["REGULAR","RETRY"]},"startTime":{"type":"string","format":"ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)","description":"Date and time when this cycle was supposed to be created according to the schedule","example":"2030-12-25T10:11:12"},"paymentId":{"type":"string","description":"Payment Id"},"paymentState":{"$ref":"#/components/schemas/PaymentState"},"amount":{"type":"number","description":"Payment amount"}}},"SubscriptionRetryStrategy":{"required":["frequency","numberOfCycles"],"type":"object","properties":{"frequency":{"type":"integer","minimum":1,"description":"The number of intervals after which the system will retry the payment after an unsuccessful attempt","example":2},"frequencyUnit":{"type":"string","description":"The interval at which the subscription is retried. Use 'MINUTE' for testing purposes only.","example":"DAY","enum":["MINUTE","DAY","WEEK","MONTH"]},"numberOfCycles":{"type":"integer","minimum":1,"description":"Required number of retries","example":12},"amountAdjustments":{"type":"array","description":"If specified, the nth element contains the percentage of the initial amount that will be charged for the nth retry","items":{"type":"integer","minimum":1}}},"description":"Retry strategy for subscription. If not specified, the subscription is canceled after the first failed payment attempt."},"Result":{"properties":{"id":{"maxLength":32,"type":"string","description":"Payment Id","example":"91d27876e87f4b22b3ecd53924bf973d"},"referenceId":{"maxLength":256,"type":"string","description":"referenceId from payment request","example":"payment-123"},"paymentType":{"$ref":"#/components/schemas/PaymentType"},"state":{"$ref":"#/components/schemas/PaymentState"},"description":{"maxLength":512,"type":"string","description":"Description of the transaction","example":"Deposit via TEST shop"},"parentPaymentId":{"maxLength":32,"type":"string","description":"Initial transaction Id from payment request","example":"91d27876e87f4b22b3ecd53924bf973d"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"paymentMethodDetails":{"$ref":"#/components/schemas/PaymentMethodDetails"},"amount":{"multipleOf":1e-18,"maximum":999999.99,"exclusiveMaximum":false,"minimum":1e-18,"exclusiveMinimum":false,"type":"number","description":"Amount sent to the payment provider","example":11.12},"currency":{"type":"string","description":"Currency sent to the payment provider","format":"ISO 4217 code for FIAT currencies or cryptocurrency symbol","example":"EUR"},"customerAmount":{"type":"number","description":"Amount from payment request. Filled only if the request currency differs from the currency sent to the payment provider.","example":15},"customerCurrency":{"type":"string","description":"Currency from payment request. Filled only if it differs from the currency sent to the payment provider.","format":"ISO 4217 code for FIAT currencies or cryptocurrency symbol","example":"USD"},"redirectUrl":{"maxLength":256,"type":"string","description":"URL to redirect the customer","example":"http://start/payment/6ccaa03cb2c242a68ce332f38fedfad7"},"errorCode":{"type":"string","description":"Check 'Error Codes' section for details","example":"1.01"},"externalResultCode":{"type":"string","description":"Result code from external provider","example":"03"},"customer":{"$ref":"#/components/schemas/Customer"},"billingAddress":{"$ref":"#/components/schemas/BillingAddress"},"startRecurring":{"type":"boolean","description":"Indicates whether this payment has started a recurring chain"},"recurringToken":{"type":"string","description":"Token that can be used to continue the recurring chain"},"terminalName":{"type":"string","description":"The name of the provider that was used to process this payment"},"externalFeeAmount":{"type":"number","description":"Provider fee. Filled only if supported by the provider.","example":15},"externalFeeCurrency":{"type":"string","description":"Provider fee currency. Filled only if supported by the provider.","format":"ISO 4217 code for FIAT currencies or cryptocurrency symbol","example":"USD"}}},"PaymentOperation":{"properties":{"id":{"type":"integer","description":"Operation Id"},"operation":{"$ref":"#/components/schemas/Operation"},"started":{"type":"string","format":"ISO 8601","description":"Operation start time","example":"2020-10-07T13:36:32.595Z"},"completed":{"type":"string","format":"ISO 8601","description":"Operation end time","example":"2020-10-07T13:36:32.595Z"},"paymentState":{"$ref":"#/components/schemas/PaymentState"},"outgoingMessages":{"type":"string","description":"List of messages sent to external APIs during operation processing"},"incomingMessages":{"type":"string","description":"List of messages received from external APIs during operation processing"}}},"PaymentRequest":{"required":["currency","paymentType"],"type":"object","properties":{"referenceId":{"maxLength":256,"type":"string","description":"Reference assigned by Merchant. Will not go outside the system. Will be sent unchanged in the PaymentResponse.","example":"payment_id=123;custom_ref=456"},"paymentType":{"$ref":"#/components/schemas/PaymentType"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"amount":{"multipleOf":1e-18,"maximum":999999.99,"exclusiveMaximum":false,"minimum":1e-18,"exclusiveMinimum":false,"type":"number","description":"Payment amount","example":11.12},"currency":{"type":"string","description":"Payment currency","format":"ISO 4217 code for FIAT currencies or cryptocurrency symbol","example":"EUR"},"parentPaymentId":{"maxLength":32,"type":"string","description":"Id of initial deposit for refunds, Id of initial recurring payment for subsequent payments","example":"91d27876e87f4b22b3ecd53924bf973d"},"description":{"maxLength":512,"type":"string","description":"Description of the transaction shown to the Customer. Can be sent outside the system.","example":"Deposit 123 via TEST shop"},"card":{"$ref":"#/components/schemas/Card"},"customer":{"$ref":"#/components/schemas/Customer"},"billingAddress":{"$ref":"#/components/schemas/BillingAddress"},"returnUrl":{"maxLength":256,"type":"string","description":"URL to redirect Customer after processing","example":"https://mywebsite.com/{id}/{referenceId}/{state}/{type}"},"webhookUrl":{"type":"string","description":"Url to receive payment status notifications","example":"https://mywebsite.com/webhooks"},"startRecurring":{"type":"boolean","description":"Send 'true' if you want this payment to initiate recurring chain. Default is 'false'."},"recurringToken":{"type":"string","description":"To continue recurring chain, send a token from a previously initiated recurring payment."},"subscription":{"$ref":"#/components/schemas/SubscriptionRequest"},"additionalParameters":{"type":"object","description":"Additional parameters required by some payment providers. Contact support for more information.","additionalProperties":{"type":"string"},"example":{"bankCode":"ABHY0065032","countryOfBirth":"CY"}}}},"PaymentListResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"ISO 8601","example":"2020-10-07T13:36:32.595Z"},"status":{"type":"integer","description":"HTTP status code","example":200},"hasMore":{"type":"boolean","description":"Indicates if there are more pages to return"},"result":{"type":"array","items":{"$ref":"#/components/schemas/Result"}}}},"PaymentResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"ISO 8601","example":"2020-10-07T13:36:32.595Z"},"status":{"type":"integer","description":"HTTP status code","example":200},"result":{"$ref":"#/components/schemas/Result"}}},"OperationListResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"ISO 8601","example":"2020-10-07T13:36:32.595Z"},"status":{"type":"integer","description":"HTTP status code","example":200},"result":{"type":"array","items":{"$ref":"#/components/schemas/PaymentOperation"}}}},"UnauthorizedError":{"required":["status","error","message","timestamp","path"],"type":"object","properties":{"status":{"type":"integer","example":401},"error":{"type":"string","example":"Unauthorized"},"message":{"type":"string","example":"Invalid token"},"timestamp":{"type":"string","format":"ISO 8601","example":"2020-10-07T13:32:19.444Z"},"path":{"type":"string","example":"/api/v1/payments"}},"example":{"status":401,"error":"Unauthorized","message":"Invalid token","timestamp":"2020-10-07T13:32:19.444Z","path":"/api/v1/resource-name"}},"NotFoundError":{"required":["status","error","message","timestamp","path"],"type":"object","properties":{"status":{"type":"integer","example":404},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"404 NOT_FOUND"},"timestamp":{"type":"string","format":"ISO 8601","example":"2020-10-07T13:32:19.444Z"},"path":{"type":"string","example":"/api/v1/payments"}},"example":{"status":404,"error":"Not Found","message":"404 NOT_FOUND","timestamp":"2020-10-07T13:32:19.444Z","path":"/api/v1/resource-name"}},"PaymentType":{"type":"string","description":"Payment Type","example":"DEPOSIT","enum":["DEPOSIT","WITHDRAWAL","REFUND"]},"PaymentMethod":{"type":"string","description":"Payment Method","example":"BASIC_CARD","enum":["BASIC_CARD","CRYPTO","FLEXEPIN","MACROPAY","SKRILL","PAYRETAILERS","LOCALPAYMENT","MONNET","PAYPAL","NETELLER","TRUSTPAYMENTS","PAYMAXIS","GATE8TRANSACT","TINK","B2BINPAY","CLICK","MONETIX","PERFECTMONEY","VOLT","KESSPAY","BILLLINE","NGENIUS","ASTROPAY","ALYCEPAY","PIX","BOLETO","UPI","PAYTM","NETBANKING","FINRAX","SPOYNT","XINPAY","OMNIMATRIX","DPOPAY","EXTERNAL_HPP","XANPAY","INRPAY","ARI10","SOFORT","GIROPAY","PAYSAFECARD","OPEN_BANKING","KLARNA","SPEI","PAYCASH","RAPIPAGO","PAGOFACIL","RAPIDTRANSFER","MOBILE_MONEY","INTERAC","INTERAC_ETO","INTERAC_RTO","INTERAC_ACH","PICPAY","MOLLIE","TED","ZIPAY","PSE","EFECTY","BANKTRANSFER","PEC","OXXO","WEBPAY","PAGOEFECTIVO","MIFINITY","PAYPORT","JETONCASH","JETONWALLET","NODA","NODA_REVOLUT","ALFAKIT","PAYFUN","EMANAT","M10","RUBPAY","MONERCHY","MUCHBETTER","YAPILY","INAI","IMPS","RTGS","PAYID","ZOTAPAY","SBP","P2P_CARD","P2P_IBAN","P2P_SBP","PUSH","GATEIQ","VIETTEL","ZALO","QR","CUP","CODI","PAY2PLAY","BKASH","NAGAD","ROCKET","PAYOUT_SEPA_BATCH","PAYOUT_NONSEPA_REQUEST"]},"PaymentState":{"type":"string","description":"Payment State","example":"PENDING","enum":["CHECKOUT","PENDING","CANCELLED","DECLINED","COMPLETED"]},"Operation":{"type":"string","description":"Operation performed during payment processing","example":"CREATE_PAYMENT","enum":["CREATE_PAYMENT","CHECKOUT","CANCEL","CONFIRMATION","CASCADING","REDIRECT","CONTINUE","CONTINUE_ANTI_FRAUD","DETECT_FRAUD","DEPOSIT","WITHDRAWAL","REFUND","CHARGEBACK","CHECK_STATE","HANDLE_WEBHOOK","MANUAL_UPDATE"]},"Error":{"type":"object","example":{"timestamp":"2020-10-07T13:31:17.110+00:00","status":400,"error":"Bad Request","message":"Validation failed for object='paymentRequest'. Error count: 1","errors":[{"codes":["NotNull.paymentRequest.currency","NotNull.currency","NotNull.java.util.Currency","NotNull"],"arguments":[{"codes":["paymentRequest.currency","currency"],"defaultMessage":"currency"}],"defaultMessage":"must not be null","objectName":"paymentRequest","field":"currency","bindingFailure":false}],"path":"/api/v1/payments"},"properties":{"timestamp":{"type":"string"},"status":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"string"}},"arguments":{"type":"array","items":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"string"}},"defaultMessage":{"type":"string"}}}},"defaultMessage":{"type":"string"},"objectName":{"type":"string"},"field":{"type":"string"},"bindingFailure":{"type":"boolean"}}}},"path":{"type":"string"}}}},"securitySchemes":{"bearerAuthentication":{"type":"http","description":"The client sends HTTP requests with the Authorization header that contains the word Bearer followed by a space and the Shop Api Key.","scheme":"bearer"}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true},"_id":"652d4585ae93b308d03f6744"},"oasPublicUrl":"@paytech/v1.0#jnsb20tlu2qej36","oauth":false,"rdmd":{"baseUrl":"/","body":"","opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{},"wrap":false},"safeMode":false,"settings":{"position":true},"theme":"light","baseUrl":"/","terms":[{"_id":"652d419afbead3005749f585","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"source":"security","_id":"65fd8fa499c89d0a3df53e2e","name":"bearerAuthentication","type":"http","scheme":"bearer","apiSetting":"652d4585ae93b308d03f6744"}]}},"terms":[{"_id":"652d419afbead3005749f585","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"source":"security","_id":"65fd8fa499c89d0a3df53e2e","name":"bearerAuthentication","type":"http","scheme":"bearer","apiSetting":"652d4585ae93b308d03f6744"}]},"mdx":false},"slugUrl":"/reference/getpayments","suggestedEdits":true,"variables":{"defaults":[{"source":"security","_id":"65fd8fa499c89d0a3df53e2e","name":"bearerAuthentication","type":"http","scheme":"bearer","apiSetting":"652d4585ae93b308d03f6744"}],"user":{}},"config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.235.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[{"_id":"652d419afbead3005749f585","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"source":"security","_id":"65fd8fa499c89d0a3df53e2e","name":"bearerAuthentication","type":"http","scheme":"bearer","apiSetting":"652d4585ae93b308d03f6744"}]},"project":{"_id":"652d419afbead3005749f584","appearance":{"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#048ef5","main_alt":"","header_text":"","body_highlight":"","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"solid","img":[],"img_size":"auto","img_pos":"tl"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"referenceSimpleMode":true,"referenceLayout":"row","link_logo_to_url":false,"theme":"solid","colorScheme":"system","overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"showMetricsInReference":true,"logo":["https://files.readme.io/45785f4-brandmark-blue.svg","readme.svg",60,60,"#048ef5"],"loginLogo":[],"logo_white":[],"logo_white_use":false,"logo_large":false,"favicon":[],"stylesheet":"","stylesheet_hub2":"","stylesheet_hub3":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":true,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"buttons","buttonPrimary":"get-started","buttonSecondary":"none"},"title":"The paytech Developer Hub","text":"Welcome to the paytech developer hub. You'll find comprehensive guides and documentation to help you start working with paytech as quickly as possible, as well as support if you get stuck. Let's jump right in!","_id":"652d419afbead3005749f586"}],"allowApiExplorerJsonEditor":false,"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false}},"custom_domain":"","childrenProjects":[],"derivedPlan":"freelaunch","description":"","error404":"","experiments":[],"first_page":"reference","flags":{"git":{"read":false,"write":false},"allowApiExplorerJsonEditor":false,"allowReusableOTPs":false,"alwaysShowDocPublishStatus":false,"allowXFrame":false,"apiV2":false,"correctnewlines":false,"customBlocks":false,"dashReact":false,"devDashHub":false,"disablePasswordlessLogin":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"disableAutoTranslate":false,"disableSAMLScoping":false,"enterprise":false,"graphql":false,"migrationRun":false,"migrationSwaggerRun":false,"newEditor":true,"newEditorDash":true,"newMarkdownBetaProgram":true,"newSearch":true,"oauth":false,"oldMarkdown":false,"owlbotAi":false,"rdmdCompatibilityMode":false,"reviewWorkflow":true,"singleProjectEnterprise":false,"speedyRender":false,"staging":false,"star":false,"superHub":false,"superHubBeta":false,"swagger":false,"translation":false,"useReactApp":true,"useReactGLP":true,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"billingRedesignEnabled":true,"developerPortal":false,"disableSignups":false,"mdx":false,"passwordlessLogin":"default","superHubDevelopment":false,"annualBillingEnabled":true,"superHubMigrationSelfServeFlow":true,"bidiSync":false,"changelogRssAlwaysPublic":false,"customComponents":false,"enableOidc":false,"disableDiscussionSpamRecaptchaBypass":false,"maskErrorMessages":true},"fullBaseUrl":"https://paytech.readme.io/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[{"_id":"652d419afbead3005749f585","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"hasOneChild":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"internal":"","jwtExpirationTime":0,"landing_bottom":[],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"thumbsEnabled":true,"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":false,"docs":false,"examples":false,"reference":true,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false},"name":"paytech","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","recipes":"","tutorials":""},"oauth_url":"","onboardingCompleted":{"api":true,"appearance":false,"documentation":true,"domain":false,"jwt":false,"logs":false,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"freelaunch","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"","planTrial":"freelaunch","readmeScore":{},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":false,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"652d419bfbead3005749f58f","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["652d419bfbead3005749f591","652d419bfbead3005749f591","652d419bfbead3005749f593","652d4585ae93b308d03f6746"],"project":"652d419afbead3005749f584","releaseDate":"2023-10-16T13:58:51.334Z","createdAt":"2023-10-16T13:58:51.351Z","updatedAt":"2023-10-16T14:15:33.913Z","__v":1},"subdomain":"paytech","subpath":"","superHubWaitlist":false,"topnav":{"left":[],"right":[{"type":"user","text":"User","url":"/login?redirect_uri=/reference/getpayments"}],"bottom":[],"edited":false},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2023-10-30T13:58:50.777Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"","versions":[{"_id":"652d419bfbead3005749f58f","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["652d419bfbead3005749f591","652d419bfbead3005749f591","652d419bfbead3005749f593","652d4585ae93b308d03f6746"],"project":"652d419afbead3005749f584","releaseDate":"2023-10-16T13:58:51.334Z","createdAt":"2023-10-16T13:58:51.351Z","updatedAt":"2023-10-16T14:15:33.913Z","__v":1}],"variableDefaults":[{"source":"security","_id":"65fd8fa499c89d0a3df53e2e","name":"bearerAuthentication","type":"http","scheme":"bearer","apiSetting":"652d4585ae93b308d03f6744"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[{"_id":"652d419afbead3005749f585","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"canonical_url":null,"description":null,"parent":null,"homepage_url":null,"id":"652d419afbead3005749f584","is_migrated":false,"name":"paytech","redirects":[],"sitemap":"disabled","subdomain":"paytech","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"bearerAuthentication","scheme":"bearer","source":"security","type":"http","id":"65fd8fa499c89d0a3df53e2e"}],"webhooks":[],"custom_login":{"login_url":null,"logout_url":null},"onboarding_completed":{"api":true,"appearance":false,"documentation":true,"domain":false,"jwt":false,"logs":false,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"view":"public","password":null},"reference":{"api_sdk_snippets":"enabled","defaults":"use_only_if_required","json_editor":"disabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"collapsed","response_schemas":"collapsed"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"freelaunch","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2023-10-30T13:58:50.777Z"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"disabled","custom_code":{"css":"disabled","html":"disabled","js":"disabled"}}},"appearance":{"brand":{"primary_color":null,"link_color":null,"theme":"system"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"show"},"logo":{"size":"default","dark_mode":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}},"main":{"uri":null,"url":"https://files.readme.io/45785f4-brandmark-blue.svg","name":"readme.svg","width":60,"height":60,"color":"#048ef5","links":{"original_url":null}},"favicon":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}},"custom_code":{"css":null,"js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"solid","gradient_color":null,"overlay":{"fill":"auto","type":"triangles","position":"top-left","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"navigation":{"first_page":"reference","left":[],"logo_link":"landing_page","right":[{"type":"user_controls","title":null,"url":null,"custom_page":null}],"sub_nav":[],"subheader_layout":"links","version":"enabled","links":{"home":{"label":"Home","visibility":"disabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":null,"visibility":"disabled"},"reference":{"label":"API Reference","alias":null,"visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"disabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}}}},"version":{"_id":"652d419bfbead3005749f58f","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["652d419bfbead3005749f591","652d419bfbead3005749f591","652d419bfbead3005749f593","652d4585ae93b308d03f6746"],"project":"652d419afbead3005749f584","releaseDate":"2023-10-16T13:58:51.334Z","createdAt":"2023-10-16T13:58:51.351Z","updatedAt":"2023-10-16T14:15:33.913Z","__v":1}},"reqUrl":"/reference/getpayments","version":{"_id":"652d419bfbead3005749f58f","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["652d419bfbead3005749f591","652d419bfbead3005749f591","652d419bfbead3005749f593","652d4585ae93b308d03f6746"],"project":"652d419afbead3005749f584","releaseDate":"2023-10-16T13:58:51.334Z","createdAt":"2023-10-16T13:58:51.351Z","updatedAt":"2023-10-16T14:15:33.913Z","__v":1},"lang":"en","langFull":"Default","isDetachedProductionSite":false}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6859,1802,9772,3284,7449,7372,9082,572,5312,5548,2395,6522,7112,4608,8263,1282,2852,3880,7783,1456,1666,5798,4935,7971,6722,153,1313,1202,1343,6841,1936,8063,1080,9852,8684,9575,4002,3787,6060,2578,3859,6922,2859,3221,7327,7285,3307,1948,5408,2637,4674,1731,2616,3412,2144,9141,678,2402,4467,4793,6794,169,7289,8899,7031,3556,1231,3826]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","routes-PageNotFound","Footer","core-icons-chevron-up-down-svg","routes-Reference","core-icons-alert-circle-svg","core-icons-more-vertical-svg","routes-Doc","core-icons-arrow-up-right-svg","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","core-icons-arrow-right-svg","routes-Landing","core-icons-lock-svg","core-icons-eye-off-svg","core-icons-chevron-down-svg","CustomPage","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","rmdx","routes-Discuss","List","core-icons-trending-up-svg","core-icons-callout-info-svg","routes-Changelog","routes-CustomPage","Post","core-icons-webhook-svg","Page","routes-Tutorials","core-graphics-json-svg","core-icons-star-svg","core-icons-code-svg","core-icons-plus-svg","core-icons-inbox-svg","New","core-icons-message-circle-svg","core-icons-key-svg","routes-Dash-ChatGPT-CopilotInstalledPage"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.766cf20fa350c2c18107.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5548.8fb1bb5d57de6c263c67.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/4608.3b5a227647e78e858c3f.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/8263.a563779273b90f66c0db.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.a3bb3020bf29f8f67ef8.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.ad57d9fcd570c04fb712.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/6722.e485c5aa155bd0f0ccf8.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"></script> <script async data-chunk="core-icons-alert-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"></script> <script async data-chunk="core-icons-more-vertical-svg" src="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"></script> <script async data-chunk="core-icons-arrow-up-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.002979730c36f9c65ad3.js"></script> <script async data-chunk="core-icons-x-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"></script> <script async data-chunk="core-icons-suggested-edits-svg" src="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.f0816876bdfbbc06801a.js"></script> <script async data-chunk="core-icons-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="core-icons-eye-off-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/2859.94b03b9a9585460aa921.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.5ccfbee71da134a1eeba.js"></script> <script async data-chunk="rmdx" src="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/4674.13378da16ce7b5beba66.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.12cee315afa198c8e23e.js"></script> <script async data-chunk="core-icons-trending-up-svg" src="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"></script> <script async data-chunk="core-icons-callout-info-svg" src="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.3f125a62ed05cc53aec4.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.cced33af5051de7f473f.js"></script> <script async data-chunk="core-icons-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.js"></script> <script async data-chunk="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.js"></script> <script async data-chunk="core-icons-star-svg" src="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"></script> <script async data-chunk="core-icons-code-svg" src="https://cdn.readme.io/public/hub/web/core-icons-code-svg.d29a4cf99a7105e13528.js"></script> <script async data-chunk="core-icons-plus-svg" src="https://cdn.readme.io/public/hub/web/core-icons-plus-svg.a49fb76ac2661b5e1c7e.js"></script> <script async data-chunk="core-icons-inbox-svg" src="https://cdn.readme.io/public/hub/web/core-icons-inbox-svg.01c2ecb759e417a98bb8.js"></script> <script async data-chunk="New" src="https://cdn.readme.io/public/hub/web/New.908bc26e77bebc585452.js"></script> <script async data-chunk="core-icons-message-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"></script> <script async data-chunk="core-icons-key-svg" src="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"></script> <script async data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" src="https://cdn.readme.io/public/hub/web/1231.f80a04007595f4936e51.js"></script> <script async data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" src="https://cdn.readme.io/public/hub/web/routes-Dash-ChatGPT-CopilotInstalledPage.905756735b64839665ac.js"></script></div><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"ZWExZjlkYzAyMjIzMzE5YTJlYzI4YjE0OGRjN2I0MGNmMDkwZGViMDE3ZWM4MTQzMTQ1ZDM3YTM0NDE3ODFjZHRhZ0ZpbHRlcnM9KHByb2plY3Q6NjUyZDQxOWFmYmVhZDMwMDU3NDlmNTg0KSwodmVyc2lvbjpub25lLHZlcnNpb246NjUyZDQxOWJmYmVhZDMwMDU3NDlmNThmKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","filters":"tagFilters=(project:652d419afbead3005749f584),(version:none,version:652d419bfbead3005749f58f),(hidden:none,hidden:false),(index:CustomPage,index:Page)","metaData":[{"modules":{"landing":false,"docs":false,"examples":false,"reference":true,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false},"id":"652d419afbead3005749f584","name":"paytech","subdomain":"paytech","subpath":"","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","recipes":"","tutorials":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>