Help
RSS
API
Feed
Maltego
Contact
Domain > docs.getpinch.com.au
×
More information on this domain is in
AlienVault OTX
Is this malicious?
Yes
No
DNS Resolutions
Date
IP Address
2018-07-10
54.175.95.86
(
ClassC
)
2018-11-08
34.226.151.187
(
ClassC
)
2026-01-08
104.16.241.118
(
ClassC
)
Port 80
HTTP/1.1 301 Moved PermanentlyDate: Thu, 08 Jan 2026 09:17:32 GMTContent-Type: text/htmlContent-Length: 167Connection: keep-aliveCache-Control: max-age3600Expires: Thu, 08 Jan 2026 10:17:32 GMTLocation: https://docs.getpinch.com.au/Server: cloudflareCF-RAY: 9baa9a33beda0384-PDXalt-svc: h3:443; ma86400 html>head>title>301 Moved Permanently/title>/head>body>center>h1>301 Moved Permanently/h1>/center>hr>center>cloudflare/center>/body>/html>
Port 443
HTTP/1.1 200 OKDate: Thu, 08 Jan 2026 09:17:32 GMTContent-Type: text/html; charsetutf-8Transfer-Encoding: chunkedConnection: keep-aliveCF-RAY: 9baa9a3418856c17-PDXCache-Control: s-maxage900, stale-if-error900content-language: enrndr-id: fb60e654-7880-429bstrict-transport-security: max-age31536000vary: Accept-Encodingx-content-type-options: nosniffx-dns-prefetch-control: offx-download-options: noopenx-frame-options: Denyx-ratelimit-limit: 100x-ratelimit-remaining: 99x-ratelimit-reset: 1767825819x-render-origin-server: Renderx-xss-protection: 1; modeblockCF-Cache-Status: REVALIDATEDServer: cloudflarealt-svc: h3:443; ma86400 !DOCTYPE html>html langen style data-color-modelight class useReactApp >head>meta charsetutf-8>meta namereadme-deploy content5.565.0>meta namereadme-subdomain contentgetpinch>meta namereadme-repo contentgetpinch-051076f8eee1>meta namereadme-version content2020.1>title>Pinch/title>meta namedescription data-rhtrue>meta propertyog:title contentPinch data-rhtrue>meta propertyog:description data-rhtrue>meta propertyog:site_name contentPinch>meta nametwitter:title contentPinch data-rhtrue>meta nametwitter:description data-rhtrue>meta nametwitter:card contentsummary_large_image>meta nameviewport contentwidthdevice-width, initial-scale1.0>meta propertyog:image contenthttps://cdn.readme.io/og-image/create?typehome&titlePinch&projectTitlePinch&descriptionPinch%20Payments%20is%20a%20simple%20and%20secure%20way%20to%20accept%20online%20payments%20from%20your%20customers.%20With%20our%20API%2C%20you%20can%20integrate%20Pinch%20Payments%20into%20your%20website%20or%20app%20and%20start%20accepting%20payments%20in%20minutes.&logoUrlhttps%3A%2F%2Ffiles.readme.io%2F4aebab6-Pinch_logo_2021.svg&color%23311B92&variantlight data-rhtrue>meta nametwitter:image contenthttps://cdn.readme.io/og-image/create?typehome&titlePinch&projectTitlePinch&descriptionPinch%20Payments%20is%20a%20simple%20and%20secure%20way%20to%20accept%20online%20payments%20from%20your%20customers.%20With%20our%20API%2C%20you%20can%20integrate%20Pinch%20Payments%20into%20your%20website%20or%20app%20and%20start%20accepting%20payments%20in%20minutes.&logoUrlhttps%3A%2F%2Ffiles.readme.io%2F4aebab6-Pinch_logo_2021.svg&color%23311B92&variantlight data-rhtrue>meta propertyog:image:width content1200>meta propertyog:image:height content630>link idfavicon relshortcut icon hrefhttps://files.readme.io/91e753c-small-favicon-32x32.png typeimage/png>link relcanonical hrefhttps://docs.getpinch.com.au/>script srchttps://cdn.readme.io/public/js/unauthorized-redirect.js?1767817892767>/script>script srchttps://cdn.readme.io/public/js/cash-dom.min.js?1767817892767>/script>link data-chunkFooter relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/Footer.7ca87f1efe735da787ba.css>link data-chunkHome relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/Home.3c7b0fb808619c2a4656.css>link data-chunkSuperHubSearch relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/SuperHubSearch.6a1ff81afa1809036d22.css>link data-chunkRDMD relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/RDMD.9331f322bb5b573f9d25.css>link data-chunkRDMD relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/28788.a87032107f4fd478ffc3.css>link data-chunkHeader relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/Header.5aae427b71d755af99f5.css>link data-chunkContainers-EndUserContainer relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/Containers-EndUserContainer.c474218e3da23db49451.css>link data-chunkmain relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/main.2f0b1fcb0624f09ee5e5.css>link data-chunkmain relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/ui-styles.aac3ac4257b580a8a15d.css>link data-chunkmain relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/main.3b129c8ad16910742dc7.js>link data-chunkroutes-SuperHub relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/routes-SuperHub.e22f1bc7bff0d7e98787.js>link data-chunkContainers-EndUserContainer relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/Containers-EndUserContainer.b902e16b915b9acb54fb.js>link data-chunkHeader relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/Header.220751c4627e9950b2e1.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/13766.d772ba54efb1db56d529.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/46123.69ebc12c0e2bace354b5.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/23781.e74aa301646844cc6f02.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/48424.bb37c5885520ec98c35d.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/16563.8ee90e74136685c009f7.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/6146.f99bcbc8d654cc36d7c8.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/65492.cd2ee63fcdce46aab92a.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/99947.1ce5a0ee52c06ee3aa91.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/6349.ee60994ef05ee0495ab4.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/45496.29fc32790c0adc953776.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/68075.6b41bfeb2f8eb674bf52.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/28788.d39c04b94380b53a9531.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/31165.bac4906f0f0787b49938.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/RDMD.b594f093c77c152b86d9.js>link data-chunkcore-icons-chevron-down-svg relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.1500d4048db301af0f24.js>link data-chunkSuperHubSearch relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/88836.466db83f0dbc8536e6f1.js>link data-chunkSuperHubSearch relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/SuperHubSearch.b20875374c8ca8654670.js>link data-chunkcore-icons-search-svg relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/core-icons-search-svg.188b3766d12ac3a86b64.js>link data-chunkcore-icons-custom-pages-svg relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.4af85e07cd1067d86542.js>link data-chunkHome relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/Home.9928b6aea1adc23067fa.js>link data-chunkFooter relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/Footer.1371fb0e905b592fbec6.js>link data-chunkmain relstylesheet hrefhttps://cdn.readme.io/public/hub/web/ui-styles.aac3ac4257b580a8a15d.css>link data-chunkmain relstylesheet hrefhttps://cdn.readme.io/public/hub/web/main.2f0b1fcb0624f09ee5e5.css>link data-chunkContainers-EndUserContainer relstylesheet hrefhttps://cdn.readme.io/public/hub/web/Containers-EndUserContainer.c474218e3da23db49451.css>link data-chunkHeader relstylesheet hrefhttps://cdn.readme.io/public/hub/web/Header.5aae427b71d755af99f5.css>link data-chunkRDMD relstylesheet hrefhttps://cdn.readme.io/public/hub/web/28788.a87032107f4fd478ffc3.css>link data-chunkRDMD relstylesheet hrefhttps://cdn.readme.io/public/hub/web/RDMD.9331f322bb5b573f9d25.css>link data-chunkSuperHubSearch relstylesheet hrefhttps://cdn.readme.io/public/hub/web/SuperHubSearch.6a1ff81afa1809036d22.css>link data-chunkHome relstylesheet hrefhttps://cdn.readme.io/public/hub/web/Home.3c7b0fb808619c2a4656.css>link data-chunkFooter relstylesheet hrefhttps://cdn.readme.io/public/hub/web/Footer.7ca87f1efe735da787ba.css>!-- CUSTOM CSS-->style titlerm-custom-css>:root{--project-color-primary:#311B92;--project-color-inverse:#fff;--recipe-button-color:#FF5263;--recipe-button-color-hover:#eb0017;--recipe-button-color-active:#b80012;--recipe-button-color-focus:rgba(255, 82, 99, 0.25);--recipe-button-color-disabled:#ffffff}identerprise .ReadMeUIisAlgoliaSearch{--project-color-primary:#311B92;--project-color-inverse:#fff}a{color:var(--color-link-primary,#ff5263)}a:hover{color:var(--color-link-primary-darken-5,#eb0017)}a.text-muted:hover{color:var(--color-link-primary,#ff5263)}.btn.btn-primary{background-color:#ff5263}.btn.btn-primary:hover{background-color:#eb0017}.theme-line #hub-landing-top h2{color:#ff5263}#hub-landing-top .btn:hover{color:#ff5263}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#311b92}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#311b92,#170859)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(undefined)}.theme-line header#hub-header #header-top{border-bottom-color:#311b92}.theme-line header#hub-header #header-top .btn{background-color:#311b92}header#hub-header #header-top #header-logo{width:160px;height:40px;margin-top:0;background-image:url(https://files.readme.io/482d331-Pinch_logo_2021_white.svg)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#311b92}#subheader-links a.active{color:#311b92!important;box-shadow:inset 0 -2px 0 #311b92}#subheader-links a:hover{color:#311b92!important;box-shadow:inset 0 -2px 0 #311b92;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#ff5263}section#hub-discuss .discussion a .discuss-body h4{color:#ff5263}section#hub-discuss .discussion a:hover .discuss-body h4{color:#eb0017}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#ff5263}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#ff5263}#hub-search-results h3 em{color:#ff5263}.main_background,.tag-item{background:#ff5263!important}.main_background:hover{background:#eb0017!important}.main_color{color:#311b92!important}.border_bottom_main_color{border-bottom:2px solid #311b92}.main_color_hover:hover{color:#311b92!important}section#hub-discuss h1{color:#ff5263}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#ff5263;background-color:#ff5263}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#eb0017;border-color:#eb0017}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#ff5263;color:#ff5263}#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,#ff5263);border-color:var(--project-color-primary,#ff5263)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#eb0017;border-color:#eb0017}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#ff5263;fill:var(--project-color-primary,#ff5263)}#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:#ff5263}.main-color-accent{border-bottom:3px solid #311b92;padding-bottom:8px}/*! BEGIN HUB_CUSTOM_STYLES */.rm-LandingPage ul{list-style:initial!important;padding-left:2em!important}/*! END HUB_CUSTOM_STYLES *//style>meta namegoogle-site-verification contentHVNeaLmEx8TXZMNNWbbNvElezK9M3h6u0-0rNa8ttGY>meta nameloadedProject contentgetpinch>script>var storedColorMode `light` system ? window.localStorage.getItem(color-scheme) : `light`document.querySelector(data-color-mode).setAttribute(data-color-mode, storedColorMode)/script>script idconfig typeapplication/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-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"git":{"sync":{"bitbucket":{"installationLink":"https://developer.atlassian.com/console/install/310151e6-ca1a-4a44-9af6-1b523fea0561?signatureAYABeMn9vqFkrg%2F1DrJAQxSyVf4AAAADAAdhd3Mta21zAEthcm46YXdzOmttczp1cy13ZXN0LTI6NzA5NTg3ODM1MjQzOmtleS83MDVlZDY3MC1mNTdjLTQxYjUtOWY5Yi1lM2YyZGNjMTQ2ZTcAuAECAQB4IOp8r3eKNYw8z2v%2FEq3%2FfvrZguoGsXpNSaDveR%2FF%2Fo0BHUxIjSWx71zNK2RycuMYSgAAAH4wfAYJKoZIhvcNAQcGoG8wbQIBADBoBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDOJgARbqndU9YM%2FRdQIBEIA7unpCah%2BIu53NA72LkkCDhNHOv%2BgRD7agXAO3jXqw0%2FAcBOB0%2F5LmpzB5f6B1HpkmsAN2i2SbsFL30nkAB2F3cy1rbXMAS2Fybjphd3M6a21zOmV1LXdlc3QtMTo3MDk1ODc4MzUyNDM6a2V5LzQ2MzBjZTZiLTAwYzMtNGRlMi04NzdiLTYyN2UyMDYwZTVjYwC4AQICAHijmwVTMt6Oj3F%2B0%2B0cVrojrS8yZ9ktpdfDxqPMSIkvHAGT%2FMTvCxC3XwnwlulZe975AAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMMUUe9d1YmFOo373TAgEQgDuJo7TayM6NL19Sj9RPooRrl8rYxwKgvu9gkLNc3GuyyovWI1xA2qTr0LQzMRsf3imrAWsywzPcsjnvuAAHYXdzLWttcwBLYXJuOmF3czprbXM6dXMtZWFzdC0xOjcwOTU4NzgzNTI0MzprZXkvNmMxMjBiYTAtNGNkNS00OTg1LWI4MmUtNDBhMDQ5NTJjYzU3ALgBAgIAeLKa7Dfn9BgbXaQmJGrkKztjV4vrreTkqr7wGwhqIYs5AZR28Sibv2eBxSIg2MydtvEAAAB%2BMHwGCSqGSIb3DQEHBqBvMG0CAQAwaAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAzzWhThsIgJwrr%2FY2ECARCAOxoaW9pob21lweyAfrIm6Fw7gd8D%2B%2F8LHk4rl3jjULDM35%2FVPuqBrqKunYZSVCCGNGB3RqpQJr%2FasASiAgAAAAAMAAAQAAAAAAAAAAAAAAAAAEokowLKsF1tMABEq%2BKNyJP%2F%2F%2F%2F%2FAAAAAQAAAAAAAAAAAAAAAQAAADJLzRcp6MkqKR43PUjOiRxxbxXYhLc6vFXEutK3%2BQ71yuPq4dC8pAHruOVQpvVcUSe8dptV8c7wR8BTJjv%2F%2FNe8r0g%3D&productbitbucket"}}},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"micro":{"baseUrl":"https://micro-beta.readme.com"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.565.0","reservedWords":{"tools":"execute-request","get-code-snippet","get-endpoint","get-request-body","get-response-schema","get-server-variables","list-endpoints","list-security-schemes","list-specs","search-specs","search","fetch"},"sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true},"shMigration":{"promoVideo":"","forceWaitlist":false,"migrationPreview":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}>/script>/head>body classbody-threes theme-solid header-solid header-bg-size-auto header-bg-pos-tl header-overlay-triangles reference-layout-row lumosity-normal no-sidebar hub-is-home>div idssr-top>/div>div idssr-main>div classApp ThemeContext ThemeContext_dark ThemeContext_classic style--color-primary:#311B92;--color-primary-inverse:#fff;--color-primary-alt:#170859;--color-primary-darken-10:#231367;--color-primary-darken-20:#140b3c;--color-primary-alpha-25:rgba(49, 27, 146, 0.25);--color-link-primary:#FF5263;--color-link-primary-darken-5:#ff384c;--color-link-primary-darken-10:#ff1f35;--color-link-primary-darken-20:#eb0017;--color-link-primary-alpha-50:rgba(255, 82, 99, 0.5);--color-link-primary-alpha-25:rgba(255, 82, 99, 0.25);--color-link-background:rgba(255, 82, 99, 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)>div classSuperHub2RNxzk6HzHiJ>div classContentWithOwlbotx4PaFDoA1KMz>div classContentWithOwlbot-content2X1XexaN8Lf2>header classHeader3zzata9F_ZPQ rm-Header_classic Header_collapsible3n0YXfOvb_Al rm-Header>div classrm-Header-top Header-topuTMpygDG4e1V Header-top_classic3g7Q6zoBy8zh>div classrm-Container rm-Container_flex>div styleoutline:none tabindex-1>a href#content target_self classButton Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary>Jump to Content/a>/div>div classrm-Header-left Header-leftADQdGVqx1wqU>a classrm-Logo Header-logo1Xy41PtkzbdG href/ target_self>img altPinch classrm-Logo-img Header-logo-img3YvV4lcGKkeb srchttps://files.readme.io/482d331-Pinch_logo_2021_white.svg/>/a>a classButton Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW href/docs target_self>Guides/a>a classButton Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW href/reference target_self>API Reference/a>a classButton Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW hrefhttps://getpinch.com.au/ target_self tohttps://getpinch.com.au/>Pinch Website/a>/div>div classrm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF>div>button aria-labelToggle navigation menu classicon-menu menu3d6DYNDa3tk5 typebutton>/button>div class>div classFlyout95xhYIIoTKtc undefined rm-Flyout data-testidflyout>div classMobileFlyout1hHJpUd-nYkd>a aria-currentpage classrm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active href/ target_self>i classicon-landing-page-2 NavItem-badge1qOxpfTiALoz rm-Header-bottom-link-icon>/i>span classNavItem-textSlZuuL489uiw>Home/span>/a>a classrm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- href/docs target_self>i classicon-guides NavItem-badge1qOxpfTiALoz rm-Header-bottom-link-icon>/i>span classNavItem-textSlZuuL489uiw>Guides/span>/a>a classrm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- href/reference target_self>i classicon-references NavItem-badge1qOxpfTiALoz rm-Header-bottom-link-icon>/i>span classNavItem-textSlZuuL489uiw>API Reference/span>/a>select classSelect Select_md NavItem-item1gDDTqaXGhm1 NavItem-item_select3UEfLN-oSjxp NavItem-item_mobile1qG3gd-Mkck->option data-url/v2017.2/ value2017.2>v2017.2/option>option data-url/v2019.1/ value2019.1>v2019.1/option>option data-url# value2020.1 selected>v2020.1/option>/select>hr classMobileFlyout-divider10xf7R2X1MeW/>a classrm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74 href/docs target_self>Guides/a>a classrm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74 href/reference target_self>API Reference/a>a classrm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74 hrefhttps://getpinch.com.au/ relnoopener target_blank tohttps://getpinch.com.au/>Pinch Website/a>a classrm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74 hrefhttps://web.getpinch.com.au relnoopener target_blank tohttps://web.getpinch.com.au>Pinch Portal/a>a classrm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74 href/login?redirect_uri/ target_self to/login?redirect_uri/>Log In/a>a classMobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo href/ target_self>img altPinch classHeader-logo-img3YvV4lcGKkeb rm-Logo-img srchttps://files.readme.io/482d331-Pinch_logo_2021_white.svg/>/a>/div>/div>/div>/div>div classHeader-left-nav2xWPWMNHOGf_>i classicon-landing-page-2 Header-left-nav-icon10glJKFwewOv>/i>Home/div>/div>div classrm-Header-right Header-right21PC2XTT6aMg>span classHeader-right_desktop14ja01RUQ7HE>a classButton Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW hrefhttps://web.getpinch.com.au target_self tohttps://web.getpinch.com.au>Pinch Portal/a>a href/login?redirect_uri/ target_self classButton Button_md Header-link2tXYTgXq85zW NavItem2xSfFaVqfRjy NavItem_mdrYO3ChA2kYvP rm-Header-top-link rm-Header-top-link_login Button_primary_ghost Button_primary>Log In/a>/span>div classHeader-searchtb6Foi0-D9Vx>button aria-labelSearch ⌘k classrm-SearchToggle data-symbol⌘>div classrm-SearchToggle-icon icon-search1>/div>/button>/div>/div>/div>div classcontainer>section classLandingPageHeader20SNhBZ58Jy5 rm-LandingPageHeader>h1 classLandingPageHeader-title16RMwPkp2O2W>Pinch API Documentation/h1>div classrm-Markdown markdown-body LandingPageHeader-text3zJOEVqnHdlf data-testidRDMD>p>The Pinch API is a simple and secure way to accept online payments from your customers. With our API, you can integrate Pinch Payments into your website or app and start accepting payments in minutes./p>/div>div aligncenter classFlex Flex_row justifystart style--flex-gap:var(--md)>a classButton Button_md LandingPageHeader-button_primaryLpo1zn3KXh20 href/reference target_self>i classicon-references>/i>span>API Reference/span>/a>a classButton Button_md LandingPageHeader-button_secondary3s2XpkqwCz8B href/docs target_self>i classicon-guides>/i>span>Guides/span>/a>/div>/section>/div>/div>div classHeader-bottom2eLKOFXMEmh5 Header-bottom_classic rm-Header-bottom>div classrm-Container rm-Container_flex>nav aria-labelPrimary navigation classHeader-leftADQdGVqx1wqU Header-subnavnVH8URdkgvEl rolenavigation>div classrm-VersionDropdown Dropdown Dropdown_closed data-testiddropdown-container>button aria-haspopupdialog classButton Button_slate_text Button_md VersionDropdown1GXDUTxJ1T95 rm-Header-bottom-link Dropdown-toggle Button_primary typebutton>span classTruncate1OzxBYrNNfH3 style--Truncate-max-width:150px>v2020.1 (latest)/span>span classIconWrapper Icon-wrapper2z2wVIeGsiUy>svg fillnone viewBox0 0 24 24 classIcon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a data-namechevron-down roleimg style--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px>path strokecurrentColor stroke-linecapround stroke-linejoinround dm6 9 6 6 6-6 classicon-stroke-width>/path>/svg>/span>/button>/div>a aria-currentpage classButton Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active href/ target_self>i classicon-landing-page-2 rm-Header-bottom-link-icon>/i>span>Home/span>/a>a classButton Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile href/docs target_self>i classicon-guides rm-Header-bottom-link-icon>/i>span>Guides/span>/a>a classButton Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile href/reference target_self>i classicon-references rm-Header-bottom-link-icon>/i>span>API Reference/span>/a>div classHeader-subnav-tabyNLkcOA6xAra styletransform:translateX(0px);width:0>/div>/nav>div classrm-Header-search Header-searchtb6Foi0-D9Vx Header-search_classic rm-Header-search_feather Header-search_featherYsmQBn55F3d9>button aria-labelSearch k classrm-SearchToggle data-symbol>div classrm-SearchToggle-icon icon-search1>/div>div classHeader-search-placeholder3Vx4OmMPcjAi rm-SearchToggle-placeholder>Search/div>kbd classKbdShortcut3gsETbU1kkU0 rm-SearchToggle-shortcut>/kbd>/button>/div>/div>/div>div classhub-search-results--reactApp idhub-search-results>div classhub-container>div classmodal-backdrop show-modal rm-SearchModal rolebutton tabindex0>div aria-labelSearch Dialog classSuperHubSearchI_obvfvvQi4g idAppSearch roletabpanel tabindex0>div data-focus-guardtrue tabindex-1 stylewidth:1px;height:0px;padding:0;overflow:hidden;position:fixed;top:1px;left:1px>/div>div data-focus-lock-disableddisabled classSuperHubSearch-container2BhYey2XE-Ij>div classSuperHubSearch-col1km8vLFgOaYj>div classSearchBoxnZBxftziZGcz>input aria-labelSearch autoCapitalizeoff autoCompleteoff autoCorrectoff spellcheckfalse tabindex0 aria-requiredfalse classInput Input_md SearchBox-inputR4jffU8l10iF typesearch value/>/div>div classSearchTabs3rNhUK3HjrRJ>div classTabs Tabs-list roletablist>div aria-labelAll aria-selectedtrue classSearchTabs-tab1TrpmhQv840T Tabs-listItem Tabs-listItem_active roletab tabindex1>span classSearchTabs-tab1TrpmhQv840T>span classIconWrapper Icon-wrapper2z2wVIeGsiUy>svg fillnone viewBox0 0 24 24 classIcon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon data-namesearch roleimg style--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px>path strokecurrentColor stroke-linecapround stroke-linejoinround dM11 19a8 8 0 1 0 0-16 8 8 0 0 0 0 16ZM21 21l-4.35-4.35 classicon-stroke-width>/path>/svg>/span>All/span>/div>div aria-labelPages aria-selectedfalse classSearchTabs-tab1TrpmhQv840T Tabs-listItem roletab tabindex1>span classSearchTabs-tab1TrpmhQv840T>span classIconWrapper Icon-wrapper2z2wVIeGsiUy>svg fillnone viewBox0 0 24 24 classIcon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon data-namecustom-pages roleimg style--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px>path strokecurrentColor stroke-linecapround stroke-linejoinround dM13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9l-7-7Z classicon-stroke-width>/path>path strokecurrentColor stroke-linecapround stroke-linejoinround dM13 2v7h7M12 11.333V12M12 18v.667M9.407 12.407l.473.473M14.12 17.12l.473.473M8.333 15H9M15 15h.667M9.407 17.593l.473-.473M14.12 12.88l.473-.473 classicon-stroke-width>/path>/svg>/span>Pages/span>/div>/div>/div>div classrm-SearchModal-empty SearchResults35_kFOb1zvxX SearchResults_emptyiWzyXErtNcQJ>span classIconWrapper Icon-wrapper2z2wVIeGsiUy>svg fillnone viewBox0 0 24 24 classIcon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a rm-SearchModal-empty-icon icon icon-search data-namesearch roleimg style--icon-color:inherit;--icon-size:var(--icon-md);--icon-stroke-width:2px>path strokecurrentColor stroke-linecapround stroke-linejoinround dM11 19a8 8 0 1 0 0-16 8 8 0 0 0 0 16ZM21 21l-4.35-4.35 classicon-stroke-width>/path>/svg>/span>h6 classTitle Title6 rm-SearchModal-empty-text>Start typing to search…/h6>/div>/div>/div>div data-focus-guardtrue tabindex-1 stylewidth:1px;height:0px;padding:0;overflow:hidden;position:fixed;top:1px;left:1px>/div>/div>/div>/div>/div>/header>main classLandingWrap2TuR_Qz-ymuB rm-LandingPage idcontent>div classLandingBlock1SYukkTO6GZd LandingBlock-TextMedia1TPFpO-A3Ggz LandingBlock_alignleft3EGkYzpQ6sRv>img classLandingBlock-TextMedia-medias2DpW5BATLRI srchttps://files.readme.io/0bc1e89-Collect-payments.png/>div classLandingBlock1SYukkTO6GZd>div classrm-Markdown markdown-body data-testidRDMD>h2 classheading heading-2 header-scroll align>div classheading-anchor anchor waypoint idour-api-allows-you-to>/div>div classheading-text>div idsection-our-api-allows-you-to classheading-anchor_backwardsCompatibility>/div>Our API allows you to:/div>a aria-labelSkip link to Our API allows you to: classheading-anchor-icon fa fa-anchor href#our-api-allows-you-to>/a>/h2>ul>li>Create and manage customers and payment methods/li>li>Charge customers for one-time or recurring payments/li>li>Manage plans and subscriptions/li>li>Handle refunds, disputes, and webhooks/li>li>Access reports and analytics/li>/ul>/div>/div>/div>div classLandingBlock1SYukkTO6GZd LandingBlock_alignleft3EGkYzpQ6sRv>div classrm-Markdown markdown-body data-testidRDMD>p>To get started, you will need a Pinch Payments account and an API key. You can a target_self hrefhttps://auth.getpinch.com.au/Register>sign up for a free developer account here/a> and get your API key from the dashboard./p>p>Our API is RESTful and uses JSON for requests and responses. You can use any programming language or tool that supports HTTP requests to interact with our API. We also provide SDKs for some popular languages to make your integration easier./p>/div>/div>div classLandingBlock1SYukkTO6GZd LandingBlock-TextMedia1TPFpO-A3Ggz LandingBlock-TextMedia_reverse2r8aZrCL7NBz LandingBlock_alignleft3EGkYzpQ6sRv>img classLandingBlock-TextMedia-medias2DpW5BATLRI srchttps://files.readme.io/c482d9b-Artwork.png/>div classLandingBlock1SYukkTO6GZd>div classrm-Markdown markdown-body data-testidRDMD>h2 classheading heading-2 header-scroll align>div classheading-anchor anchor waypoint idin-this-documentation-you-will-find>/div>div classheading-text>div idsection-in-this-documentation-you-will-find classheading-anchor_backwardsCompatibility>/div>In this documentation, you will find:/div>a aria-labelSkip link to In this documentation, you will find: classheading-anchor-icon fa fa-anchor href#in-this-documentation-you-will-find>/a>/h2>ul>li>Getting started guides to help you make your first API call for working with a target_self href/docs/credit-card-payments>Credit Card/a> or a target_self href/docs/direct-debit-payments>Direct Debit/a>/li>li>a target_self href/reference>A reference section/a> with detailed information on each API endpoint and parameter/li>li>Code examples in various languages to show you how to use our SDKs/li>/ul>/div>/div>/div>div classLandingBlock1SYukkTO6GZd LandingBlock_alignleft3EGkYzpQ6sRv>div classrm-Markdown markdown-body data-testidRDMD>p>We hope you enjoy using our API and we look forward to hearing your feedback. If you have any questions or need any help, please a target_self hrefhttps://helpdesk.getpinch.com.au/kb-tickets/new>contact support/a>./p>/div>/div>div classLandingBlock1SYukkTO6GZd LandingBlock-Docs-OGYczFIHqcw LandingBlock_alignleft3EGkYzpQ6sRv>div classmarkdown-body>h3>Getting Started/h3>ul>li>a href/docs/get-started-with-the-pinch-api>Getting started with the Pinch API/a>/li>li>a href/docs/application-authentication>Application Authentication/a>/li>li>a href/docs/credit-card-payments>Credit Card Payments/a>/li>li>a classLandingBlock-link_viewAll3A3QMhGS-MWO href/docs/get-started-with-the-pinch-api>View More…/a>/li>/ul>/div>div classmarkdown-body>h3>General Information/h3>ul>li>a href/docs/support>Get Support/a>/li>li>a href/docs/sdk>Get an SDK/a>/li>li>a href/docs/versioning>API Versions/a>/li>li>a classLandingBlock-link_viewAll3A3QMhGS-MWO href/docs/support>View More…/a>/li>/ul>/div>div classmarkdown-body>h3>Low Touch Integrations/h3>ul>li>a href/docs/low-touch-accounting-integration>Low-Touch Integration Guide for SAAS Platforms/a>/li>/ul>/div>div classmarkdown-body>h3>Managed Merchants/h3>ul>li>a href/docs/managed-merchants>Managed Merchants Guide/a>/li>li>a href/docs/managed-merchants-payments-guide>Managed Merchants Payments Guide/a>/li>/ul>/div>div classmarkdown-body>h3>Advanced Features/h3>ul>li>a href/docs/metadata>Metadata/a>/li>li>a href/docs/webhooks>Webhooks/a>/li>li>a href/docs/xero-invoice-automation>Xero invoice automation guide/a>/li>/ul>/div>div classmarkdown-body>h3>Zapier/h3>ul>li>a href/docs/getting-started-with-pinch-zapier-integration>Getting started with Pinch Zapier integration/a>/li>li>a href/docs/zapier-triggers>Zapier Triggers/a>/li>li>a href/docs/zapier-actions>Zapier Actions/a>/li>li>a classLandingBlock-link_viewAll3A3QMhGS-MWO href/docs/getting-started-with-pinch-zapier-integration>View More…/a>/li>/ul>/div>div classmarkdown-body>h3>viaSocket/h3>ul>li>a href/docs/getting-started-with-pinch-viasocket-integration>Getting started with Pinch viaSocket integration/a>/li>/ul>/div>/div>/main>footer aria-labelStatus banner classFooter2U8XAPoGhlgO AppFooter rm-Banners>/footer>div classModalWrapper idChatGPT-modal>/div>/div>/div>/div>div classModalWrapper idtutorialmodal-root>/div>/div>/div>div classng-non-bindable>script idssr-props data-initial-props{"sidebars":{},"apiBaseUrl":"/","baseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"YjM4NGIwOTc4ZTNkMmM5MzdmZTdhYzcwOTMwZjUxNzExODVlM2FkNWVlNDVkMTliYzFiNDNjNjBkNzQzMWVhM3RhZ0ZpbHRlcnM9KHByb2plY3Q6NTcxOWZmMDg2MzQ2ODUwZTAwODM0MjVlKSwodmVyc2lvbjpub25lLHZlcnNpb246NjA5MjNkMTRiMzM1YzIwMDQyMDdmYTliKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ","indexName":"readme_search_v2","projectsMeta":{"modules":{"reference":true,"suggested_edits":false,"discuss":false,"docs":true,"examples":true,"landing":true,"changelog":false,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"id":"5719ff086346850e0083425e","name":"Pinch","subdomain":"getpinch","subpath":"","nav_names":{"discuss":"","docs":"Guides","reference":"API Reference","changelog":"Changelog","tutorials":"","recipes":""}},"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":},"project":{"subdomain":"getpinch"},"version":"2020.1"}},"changelogs":,"discuss":{"anonymous_user":{"name":"Bach Vo"},"algolia":{"publishPending":false,"recordCount":0,"updatedAt":"2025-02-21T07:54:09.473Z"},"_id":"65fa51052efb8300606a67ff","title":"Are there any encryption options when calling API?","votes":0,"voters":,"hub2voters":,"views":697,"type":"question","solved":true,"body":"Hi there,\n\nIve looked through the document and found that when we use the API to submit the credit-card information, it sends the CVC with plain text. Which I found is not fully secure. Any advice?\n\n\n\nThanks!","isSpam":false,"isFAQ":false,"edited":false,"comments":"65fa5fbb5adef70011f249a2","661e14d68e08de0019cd49e7","671234c6fdfaaf001f753192","tags":,"revision":702,"createdAt":"2024-03-20T02:59:17.494Z","updatedAt":"2024-03-20T02:59:17.494Z","project":"5719ff086346850e0083425e","initVersion":"60923d14b335c2004207fa9b","__v":3,"searchContents":"Hi there, Ive looked through the document and found that when we use the API to submit the credit-card information, it sends the CVC with plain text. Which I found is not fully secure. Any advice? Thanks!","effective_user":{"name":"Bach Vo","isAdmin":false},"vote_count":0,"id":"65fa51052efb8300606a67ff"},{"anonymous_user":{"name":"Milan Hirpara"},"algolia":{"publishPending":false,"recordCount":0,"updatedAt":"2025-02-21T07:54:09.479Z"},"_id":"65f00184f61342003f8b8160","title":"How to setup installment payment","votes":0,"voters":,"hub2voters":,"views":764,"type":"question","solved":true,"body":"Hello There,\n\nWe have a requirement to integrate a payment gateway into our checkout screen, similar to selecting between different payment methods like card or PayPal. This integration will enable our users to make payments through the Pinch service.\n\nWhat we required is user can be able to setup payment in instalments where user can select installment number and system should be able to execute payment as per selected installments.","isSpam":false,"isFAQ":false,"edited":false,"comments":"65f38b1a2106bd00675cdf90","65fa5fc2d8cc5d002188511f","tags":,"revision":770,"createdAt":"2024-03-12T07:17:24.103Z","updatedAt":"2024-03-12T07:17:24.103Z","project":"5719ff086346850e0083425e","initVersion":"60923d14b335c2004207fa9b","__v":4,"searchContents":"Hello There, We have a requirement to integrate a payment gateway into our checkout screen, similar to selecting between different payment methods like card or PayPal. This integration will enable our users to make payments through the Pinch service. What we required is user can be able to setup payment in instalments where user can select installment number and system should be able to execute payment as per selected installments.","effective_user":{"name":"Milan Hirpara","isAdmin":false},"vote_count":0,"id":"65f00184f61342003f8b8160"},"guideCategories":{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"get-started-with-the-pinch-api","title":"Getting started with the Pinch API","type":"basic","updatedAt":"2025-12-13T01:13:45.000Z","pages":,"uri":"/branches/2020.1/guides/get-started-with-the-pinch-api","category":"/branches/2020.1/categories/guides/Getting Started","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"application-authentication","title":"Application Authentication","type":"basic","updatedAt":"2025-12-13T01:13:45.000Z","pages":,"uri":"/branches/2020.1/guides/application-authentication","category":"/branches/2020.1/categories/guides/Getting Started","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"credit-card-payments","title":"Credit Card Payments","type":"basic","updatedAt":"2025-12-13T01:13:45.000Z","pages":,"uri":"/branches/2020.1/guides/credit-card-payments","category":"/branches/2020.1/categories/guides/Getting Started","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"direct-debit-payments","title":"Direct Debit Payments","type":"basic","updatedAt":"2025-12-13T01:13:45.000Z","pages":,"uri":"/branches/2020.1/guides/direct-debit-payments","category":"/branches/2020.1/categories/guides/Getting Started","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"capturejs-tokenisation","title":"Tokenisation with CaptureJs","type":"basic","updatedAt":"2025-12-18T22:26:14.000Z","pages":,"uri":"/branches/2020.1/guides/capturejs-tokenisation","category":"/branches/2020.1/categories/guides/Getting Started","parent":null},"title":"Getting Started","uri":"/branches/2020.1/categories/guides/Getting Started"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"support","title":"Get Support","type":"basic","updatedAt":"2025-12-18T22:26:14.000Z","pages":,"uri":"/branches/2020.1/guides/support","category":"/branches/2020.1/categories/guides/General Information","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"sdk","title":"Get an SDK","type":"basic","updatedAt":"2025-12-18T22:26:14.000Z","pages":,"uri":"/branches/2020.1/guides/sdk","category":"/branches/2020.1/categories/guides/General Information","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"versioning","title":"API Versions","type":"basic","updatedAt":"2025-12-23T06:58:15.000Z","pages":,"uri":"/branches/2020.1/guides/versioning","category":"/branches/2020.1/categories/guides/General Information","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"dishonour-codes","title":"Dishonour Codes","type":"basic","updatedAt":"2025-12-18T22:26:14.000Z","pages":,"uri":"/branches/2020.1/guides/dishonour-codes","category":"/branches/2020.1/categories/guides/General Information","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"test-and-live-mode","title":"Test and Live Mode","type":"basic","updatedAt":"2025-12-18T22:26:14.000Z","pages":,"uri":"/branches/2020.1/guides/test-and-live-mode","category":"/branches/2020.1/categories/guides/General Information","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"payment-statuses","title":"Payment Statuses","type":"basic","updatedAt":"2025-12-18T22:26:14.000Z","pages":,"uri":"/branches/2020.1/guides/payment-statuses","category":"/branches/2020.1/categories/guides/General Information","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"refund-statuses","title":"Refund Statuses","type":"basic","updatedAt":"2025-12-13T01:49:59.000Z","pages":,"uri":"/branches/2020.1/guides/refund-statuses","category":"/branches/2020.1/categories/guides/General Information","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"surcharging-fees-in-pinch","title":"Surcharging Fees in Pinch","type":"basic","updatedAt":"2025-12-13T01:13:45.000Z","pages":,"uri":"/branches/2020.1/guides/surcharging-fees-in-pinch","category":"/branches/2020.1/categories/guides/General Information","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"errors","title":"API Error Responses","type":"basic","updatedAt":"2025-12-13T01:13:45.000Z","pages":,"uri":"/branches/2020.1/guides/errors","category":"/branches/2020.1/categories/guides/General Information","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"events","title":"Events","type":"basic","updatedAt":"2025-12-13T01:13:45.000Z","pages":,"uri":"/branches/2020.1/guides/events","category":"/branches/2020.1/categories/guides/General Information","parent":null},"title":"General Information","uri":"/branches/2020.1/categories/guides/General Information"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"low-touch-accounting-integration","title":"Low-Touch Integration Guide for SAAS Platforms","type":"basic","updatedAt":"2025-12-13T01:13:45.000Z","pages":,"uri":"/branches/2020.1/guides/low-touch-accounting-integration","category":"/branches/2020.1/categories/guides/Low Touch Integrations","parent":null},"title":"Low Touch Integrations","uri":"/branches/2020.1/categories/guides/Low Touch Integrations"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"managed-merchants","title":"Managed Merchants Guide","type":"basic","updatedAt":"2025-12-18T22:26:14.000Z","pages":,"uri":"/branches/2020.1/guides/managed-merchants","category":"/branches/2020.1/categories/guides/Managed Merchants","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"managed-merchants-payments-guide","title":"Managed Merchants Payments Guide","type":"basic","updatedAt":"2025-12-18T22:26:14.000Z","pages":,"uri":"/branches/2020.1/guides/managed-merchants-payments-guide","category":"/branches/2020.1/categories/guides/Managed Merchants","parent":null},"title":"Managed Merchants","uri":"/branches/2020.1/categories/guides/Managed Merchants"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"metadata","title":"Metadata","type":"basic","updatedAt":"2025-12-13T01:13:45.000Z","pages":,"uri":"/branches/2020.1/guides/metadata","category":"/branches/2020.1/categories/guides/Advanced Features","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"webhooks","title":"Webhooks","type":"basic","updatedAt":"2025-12-18T22:26:14.000Z","pages":,"uri":"/branches/2020.1/guides/webhooks","category":"/branches/2020.1/categories/guides/Advanced Features","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"xero-invoice-automation","title":"Xero invoice automation guide","type":"basic","updatedAt":"2025-12-13T01:13:45.000Z","pages":,"uri":"/branches/2020.1/guides/xero-invoice-automation","category":"/branches/2020.1/categories/guides/Advanced Features","parent":null},"title":"Advanced Features","uri":"/branches/2020.1/categories/guides/Advanced Features"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"getting-started-with-pinch-zapier-integration","title":"Getting started with Pinch Zapier integration","type":"basic","updatedAt":"2025-12-13T01:13:45.000Z","pages":,"uri":"/branches/2020.1/guides/getting-started-with-pinch-zapier-integration","category":"/branches/2020.1/categories/guides/Zapier","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"zapier-triggers","title":"Zapier Triggers","type":"basic","updatedAt":"2025-12-18T22:26:14.000Z","pages":,"uri":"/branches/2020.1/guides/zapier-triggers","category":"/branches/2020.1/categories/guides/Zapier","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"zapier-actions","title":"Zapier Actions","type":"basic","updatedAt":"2025-12-18T22:26:14.000Z","pages":,"uri":"/branches/2020.1/guides/zapier-actions","category":"/branches/2020.1/categories/guides/Zapier","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"pinch-in-zapier-examples","title":"Zapier examples using Pinch","type":"basic","updatedAt":"2025-12-13T01:13:45.000Z","pages":,"uri":"/branches/2020.1/guides/pinch-in-zapier-examples","category":"/branches/2020.1/categories/guides/Zapier","parent":null},"title":"Zapier","uri":"/branches/2020.1/categories/guides/Zapier"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"getting-started-with-pinch-viasocket-integration","title":"Getting started with Pinch viaSocket integration","type":"basic","updatedAt":"2025-12-18T22:26:14.000Z","pages":,"uri":"/branches/2020.1/guides/getting-started-with-pinch-viasocket-integration","category":"/branches/2020.1/categories/guides/viaSocket","parent":null},"title":"viaSocket","uri":"/branches/2020.1/categories/guides/viaSocket"},"referenceCategories":{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"my-requests","title":"My Requests","type":"api_config","updatedAt":"2026-01-07T10:56:57.000Z","api_config":"my-requests","pages":,"uri":"/branches/2020.1/reference/my-requests","category":"/branches/2020.1/categories/reference/ReadMeConfig","parent":null},"title":"ReadMeConfig","uri":"/branches/2020.1/categories/reference/ReadMeConfig"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"things-to-know","title":"Things to know","type":"basic","updatedAt":"2026-01-07T10:56:57.000Z","pages":,"uri":"/branches/2020.1/reference/things-to-know","category":"/branches/2020.1/categories/reference/Before you start!","parent":null},"title":"Before you start!","uri":"/branches/2020.1/categories/reference/Before you start!"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"tokens","title":"Authentication","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/tokens","category":"/branches/2020.1/categories/reference/Authentication","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"health","title":"Health","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/health","category":"/branches/2020.1/categories/reference/Authentication","parent":null},"title":"Authentication","uri":"/branches/2020.1/categories/reference/Authentication"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"save-payer","title":"Create or Update Payer","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/save-payer","category":"/branches/2020.1/categories/reference/Payers","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"get-payer","title":"Get Payer","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/get-payer","category":"/branches/2020.1/categories/reference/Payers","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-payers","title":"List Payers","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/list-payers","category":"/branches/2020.1/categories/reference/Payers","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"delete-payer","title":"Delete Payer","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"delete","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/delete-payer","category":"/branches/2020.1/categories/reference/Payers","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"create-payment-source","title":"Create Payment Source","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/create-payment-source","category":"/branches/2020.1/categories/reference/Payers","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"delete-payment-source","title":"Delete Payment Source","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"delete","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/delete-payment-source","category":"/branches/2020.1/categories/reference/Payers","parent":null},"title":"Payers","uri":"/branches/2020.1/categories/reference/Payers"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"save-payment","title":"Create or Update Payment","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/save-payment","category":"/branches/2020.1/categories/reference/Payments","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"realtime-payment","title":"Create Realtime Payment","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/realtime-payment","category":"/branches/2020.1/categories/reference/Payments","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"get-payment","title":"Get Payment","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/get-payment","category":"/branches/2020.1/categories/reference/Payments","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-scheduled-payments","title":"List Payments - Scheduled","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/list-scheduled-payments","category":"/branches/2020.1/categories/reference/Payments","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-processed-payments","title":"List Payments - Processed","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/list-processed-payments","category":"/branches/2020.1/categories/reference/Payments","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-payments-for-payer","title":"List Payments for Payer","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/list-payments-for-payer","category":"/branches/2020.1/categories/reference/Payments","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"delete-payment","title":"Delete payment","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"delete","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/delete-payment","category":"/branches/2020.1/categories/reference/Payments","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"check-payment-nonce","title":"Check Payment Nonce","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/check-payment-nonce","category":"/branches/2020.1/categories/reference/Payments","parent":null},"title":"Payments","uri":"/branches/2020.1/categories/reference/Payments"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"update-merchant","title":"Update Merchant","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/update-merchant","category":"/branches/2020.1/categories/reference/Merchants","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-merchants","title":"Get Merchant","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/list-merchants","category":"/branches/2020.1/categories/reference/Merchants","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"create-managed-merchant","title":"Create Managed Merchant","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/create-managed-merchant","category":"/branches/2020.1/categories/reference/Merchants","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-managed-merchants","title":"List Managed Merchants","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/list-managed-merchants","category":"/branches/2020.1/categories/reference/Merchants","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"upload-document","title":"Upload Document","type":"endpoint","updatedAt":"2025-12-12T05:20:31.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/upload-document","category":"/branches/2020.1/categories/reference/Merchants","parent":null},"title":"Merchants","uri":"/branches/2020.1/categories/reference/Merchants"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"save-plan","title":"Create or Update Plan","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/save-plan","category":"/branches/2020.1/categories/reference/Plans and Subscriptions","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"get-plan","title":"Get Plan","type":"endpoint","updatedAt":"2025-12-12T05:20:31.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/get-plan","category":"/branches/2020.1/categories/reference/Plans and Subscriptions","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-plans","title":"List Plans","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/list-plans","category":"/branches/2020.1/categories/reference/Plans and Subscriptions","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"delete-plan","title":"Delete Plan","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"delete","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/delete-plan","category":"/branches/2020.1/categories/reference/Plans and Subscriptions","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"create-subscription","title":"Create Subscription","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/create-subscription","category":"/branches/2020.1/categories/reference/Plans and Subscriptions","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"list-subscriptions","title":"List Subscriptions","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/list-subscriptions","category":"/branches/2020.1/categories/reference/Plans and Subscriptions","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"get-subscription","title":"Get Subscription","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/get-subscription","category":"/branches/2020.1/categories/reference/Plans and Subscriptions","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"cancel-subscription","title":"Cancel Subscription","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"delete","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/cancel-subscription","category":"/branches/2020.1/categories/reference/Plans and Subscriptions","parent":null},"title":"Plans and Subscriptions","uri":"/branches/2020.1/categories/reference/Plans and Subscriptions"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-all-events","title":"List all events","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/list-all-events","category":"/branches/2020.1/categories/reference/Events","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"get-event","title":"Get Event","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/get-event","category":"/branches/2020.1/categories/reference/Events","parent":null},"title":"Events","uri":"/branches/2020.1/categories/reference/Events"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-all-transfers","title":"List all transfers","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/list-all-transfers","category":"/branches/2020.1/categories/reference/Transfers","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get-transfer","title":"Get Transfer","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/get-transfer","category":"/branches/2020.1/categories/reference/Transfers","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-transfer-line-items","title":"List transfer line items","type":"endpoint","updatedAt":"2025-12-12T05:20:31.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/list-transfer-line-items","category":"/branches/2020.1/categories/reference/Transfers","parent":null},"title":"Transfers","uri":"/branches/2020.1/categories/reference/Transfers"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get-fees","title":"Get Fees","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/get-fees","category":"/branches/2020.1/categories/reference/Fees","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"calculate-fees","title":"Calculate Fees","type":"endpoint","updatedAt":"2025-12-12T05:20:31.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/calculate-fees","category":"/branches/2020.1/categories/reference/Fees","parent":null},"title":"Fees","uri":"/branches/2020.1/categories/reference/Fees"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"create-or-update-webhook","title":"Create or Update Webhook","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/create-or-update-webhook","category":"/branches/2020.1/categories/reference/Webhooks","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-webhooks","title":"List Webhooks","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/list-webhooks","category":"/branches/2020.1/categories/reference/Webhooks","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get-webhook","title":"Get Webhook","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/get-webhook","category":"/branches/2020.1/categories/reference/Webhooks","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"delete-webhook","title":"Delete Webhook","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"delete","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/delete-webhook","category":"/branches/2020.1/categories/reference/Webhooks","parent":null},"title":"Webhooks","uri":"/branches/2020.1/categories/reference/Webhooks"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"tokenise","title":"Tokenise Payment Source","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/tokenise","category":"/branches/2020.1/categories/reference/TokenISation","parent":null},"title":"TokenISation","uri":"/branches/2020.1/categories/reference/TokenISation"},{"pages":{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"create-a-refund","title":"Create a Refund","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/create-a-refund","category":"/branches/2020.1/categories/reference/Refunds","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-refunds","title":"List Refunds","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/list-refunds","category":"/branches/2020.1/categories/reference/Refunds","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"get-refund","title":"Get Refund","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"get","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/get-refund","category":"/branches/2020.1/categories/reference/Refunds","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"check-refund-nonce","title":"Check Refund Nonce","type":"endpoint","updatedAt":"2026-01-07T10:56:57.000Z","api_method":"post","api_webhook":false,"api_renderable":{"status":true},"pages":,"uri":"/branches/2020.1/reference/check-refund-nonce","category":"/branches/2020.1/categories/reference/Refunds","parent":null},"title":"Refunds","uri":"/branches/2020.1/categories/reference/Refunds"},"meta":{"title":"Pinch","type":"home"},"aiConfig":{"enabled":false,"settings":{"errors":null,"styleguide":null,"warnings":null}},"branches":{"total":0,"data":,"type":"branch"},"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-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"git":{"sync":{"bitbucket":{"installationLink":"https://developer.atlassian.com/console/install/310151e6-ca1a-4a44-9af6-1b523fea0561?signatureAYABeMn9vqFkrg%2F1DrJAQxSyVf4AAAADAAdhd3Mta21zAEthcm46YXdzOmttczp1cy13ZXN0LTI6NzA5NTg3ODM1MjQzOmtleS83MDVlZDY3MC1mNTdjLTQxYjUtOWY5Yi1lM2YyZGNjMTQ2ZTcAuAECAQB4IOp8r3eKNYw8z2v%2FEq3%2FfvrZguoGsXpNSaDveR%2FF%2Fo0BHUxIjSWx71zNK2RycuMYSgAAAH4wfAYJKoZIhvcNAQcGoG8wbQIBADBoBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDOJgARbqndU9YM%2FRdQIBEIA7unpCah%2BIu53NA72LkkCDhNHOv%2BgRD7agXAO3jXqw0%2FAcBOB0%2F5LmpzB5f6B1HpkmsAN2i2SbsFL30nkAB2F3cy1rbXMAS2Fybjphd3M6a21zOmV1LXdlc3QtMTo3MDk1ODc4MzUyNDM6a2V5LzQ2MzBjZTZiLTAwYzMtNGRlMi04NzdiLTYyN2UyMDYwZTVjYwC4AQICAHijmwVTMt6Oj3F%2B0%2B0cVrojrS8yZ9ktpdfDxqPMSIkvHAGT%2FMTvCxC3XwnwlulZe975AAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMMUUe9d1YmFOo373TAgEQgDuJo7TayM6NL19Sj9RPooRrl8rYxwKgvu9gkLNc3GuyyovWI1xA2qTr0LQzMRsf3imrAWsywzPcsjnvuAAHYXdzLWttcwBLYXJuOmF3czprbXM6dXMtZWFzdC0xOjcwOTU4NzgzNTI0MzprZXkvNmMxMjBiYTAtNGNkNS00OTg1LWI4MmUtNDBhMDQ5NTJjYzU3ALgBAgIAeLKa7Dfn9BgbXaQmJGrkKztjV4vrreTkqr7wGwhqIYs5AZR28Sibv2eBxSIg2MydtvEAAAB%2BMHwGCSqGSIb3DQEHBqBvMG0CAQAwaAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAzzWhThsIgJwrr%2FY2ECARCAOxoaW9pob21lweyAfrIm6Fw7gd8D%2B%2F8LHk4rl3jjULDM35%2FVPuqBrqKunYZSVCCGNGB3RqpQJr%2FasASiAgAAAAAMAAAQAAAAAAAAAAAAAAAAAEokowLKsF1tMABEq%2BKNyJP%2F%2F%2F%2F%2FAAAAAQAAAAAAAAAAAAAAAQAAADJLzRcp6MkqKR43PUjOiRxxbxXYhLc6vFXEutK3%2BQ71yuPq4dC8pAHruOVQpvVcUSe8dptV8c7wR8BTJjv%2F%2FNe8r0g%3D&productbitbucket"}}},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"micro":{"baseUrl":"https://micro-beta.readme.com"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.565.0","reservedWords":{"tools":"execute-request","get-code-snippet","get-endpoint","get-request-body","get-response-schema","get-server-variables","list-endpoints","list-security-schemes","list-specs","search-specs","search","fetch"},"sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true},"shMigration":{"promoVideo":"","forceWaitlist":false,"migrationPreview":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{"isAuthenticated":false},"terms":{"_id":"685024195aa634005f24dedb","term":"Pre-Approval","definition":"A Pre-Approval is a Pinch term for a stored payment method with approval from the customer for automatic payments. A Pre-Approval can be setup as unlimited or with a limit to only automatically pay invoices under a certain value."},"variables":{"user":{},"defaults":},"project":{"_id":"5719ff086346850e0083425e","accessRules":{"branch_merge":{"admin":true,"editor":false},"branch_approve":{"admin":true,"editor":false}},"ai":{"chat":{"knowledge":{"custom_knowledge":null,"use_project_knowledge":false},"models":}},"appearance":{"html_head":"","landing":true,"stylesheet_hub2":".rm-LandingPage ul {\n list-style: initial!important;\n padding-left: 2em!important; \n}","html_footer":"","html_body":"","html_promo":"","logo":"https://files.readme.io/4aebab6-Pinch_logo_2021.svg","4aebab6-Pinch_logo_2021.svg",161,40,"#ff5263","65287cf40986fd00594d6363","promos":{"title":"Pinch API Documentation","text":"The Pinch API is a simple and secure way to accept online payments from your customers. With our API, you can integrate Pinch Payments into your website or app and start accepting payments in minutes.","extras":{"type":"buttons","buttonPrimary":"reference","buttonSecondary":"docs"},"_id":"5719ff086346850e0083425f"},"favicon":"https://files.readme.io/91e753c-small-favicon-32x32.png","91e753c-small-favicon-32x32.png",32,32,"#000000","https://files.readme.io/b7d4d68-favicon-32x32.png","overlay":"triangles","stylesheet":"","colors":{"body_highlight":"#FF5263","header_text":"","highlight":"","main":"#311B92","main_alt":"","custom_login_link_color":""},"hide_logo":false,"javascript_hub2":"","link_logo_to_url":false,"logo_white":"https://files.readme.io/482d331-Pinch_logo_2021_white.svg","482d331-Pinch_logo_2021_white.svg",300,75,"#000000","65287d0c472d79007aa69cc7","nextStepsLabel":"","categoriesAsDropdown":false,"notheme":false,"showVersion":true,"sticky":false,"theme":"solid","body":{"style":"threes"},"javascript":"","main_body":{"type":"all-docs"},"hideTableOfContents":false,"html_footer_meta":"","html_hidelinks":false,"logo_white_use":true,"typography":{"tk_body":"","tk_headline":"","tk_key":"","typekit":false,"body":"Open+Sans:400:sans-serif","headline":"Open+Sans:400:sans-serif"},"header":{"img_pos":"tl","img_size":"auto","img":,"style":"solid","linkStyle":"buttons"},"referenceLayout":"row","childrenAsPills":false,"global_landing_page":{"html":"","redirect":""},"splitReferenceDocs":false,"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":""}},"subheaderStyle":"links","showMetricsInReference":true,"referenceSimpleMode":false,"stylesheet_hub3":"","loginLogo":,"logo_large":false,"colorScheme":"light","changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false,"ai_dropdown":"enabled","ai_options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","view_as_markdown":"enabled","copilot":"enabled","ask_ai":"disabled"},"showPageIcons":true,"layout":{"full_width":false,"style":"classic"},"methodBadgeStyle":"classic","showMethodInSidebar":true,"showBreadcrumbs":false},"custom_domain":"docs.getpinch.com.au","childrenProjects":,"derivedPlan":"startup","description":"Pinch Payments is a simple and secure way to accept online payments from your customers. With our API, you can integrate Pinch Payments into your website or app and start accepting payments in minutes.","isExternalSnippetActive":false,"error404":"","experiments":,"first_page":"landing","flags":{"hideGoogleAnalytics":false,"stripe":false,"correctnewlines":false,"enterprise":false,"jwt":false,"oauth":false,"speedyRender":false,"swagger":false,"allowXFrame":false,"autoSslGeneration":true,"hub2":true,"migrationSwaggerRun":true,"allowImport":false,"allow_hub2":false,"migrationRun":true,"cacheEnabled":true,"newApiExplorer":true,"alwaysShowDocPublishStatus":false,"cookieAuthentication":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"newEditor":true,"newMarkdown":false,"translation":false,"newMarkdownBetaProgram":true,"newMarkdownLooseMode":false,"oldMarkdown":false,"newSearch":true,"tutorials":true,"useReactApp":true,"allowApiExplorerJsonEditor":false,"newHeader":false,"rdmdCompatibilityMode":false,"referenceRedesign":false,"staging":false,"auth0Oauth":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":true,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":false,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":true,"developerDashboard":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"owlbotAi":false,"apiV2":false,"git":{"read":false,"write":false},"superHubBeta":false,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":true,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":true,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":false,"gitSidebar":false,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":false,"externalSdkSnippets":false,"migrationPreview":false,"requiresJQuery":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":false,"aiDocsAudit":false,"aiPageLinting":false,"gitlabCloudSync":false,"bidiSyncGitlabSelfServe":true,"superHubPlanManagement":true,"bidiSyncBitbucketSelfServe":false,"disableAiChat":false,"hideAiFeatures":false,"disableSuperframe":false,"gitTranslations":false,"githubCloudSync":true,"mdxSanitizeComments":false,"mdxish":false,"superHubBranchMergeRules":false},"fullBaseUrl":"https://docs.getpinch.com.au/","git":{"migration":{"createRepository":{"start":"2025-06-09T07:06:27.565Z","end":"2025-06-09T07:06:28.024Z","status":"successful"},"transformation":{"end":"2025-06-09T07:06:28.665Z","start":"2025-06-09T07:06:28.192Z","status":"successful"},"migratingPages":{"end":"2025-06-09T07:06:29.492Z","start":"2025-06-09T07:06:28.792Z","status":"successful"},"enableSuperhub":{"start":"2025-06-09T07:08:37.485Z","status":"successful","end":"2025-06-09T07:08:37.486Z"}},"sync":{"linked_repository":{"_id":"6846af319f3957011e174e55","provider_type":"github","id":"995169165","name":"docs","url":"https://github.com/PinchPayments/docs","privacy":{"private":true,"visibility":"internal"},"linked_at":"2025-06-09T09:53:53.932Z","linked_by":"damian@getpinch.com.au","connection":"6846af29406fcb003057666b","full_name":"PinchPayments/docs","error":{}},"installationRequest":{},"connections":{"_id":"6846af29406fcb003057666b","active":true,"created_at":"2025-06-09T09:53:44.000Z","created_by":"damian@getpinch.com.au","installation_id":70490357,"owner":{"type":"Organization","id":83333876,"login":"PinchPayments","site_admin":false},"provider_type":"github"},"providers":},"renamedSlugs":},"gitMigrationStatus":"migrated","glossaryTerms":{"_id":"685024195aa634005f24dedb","term":"Pre-Approval","definition":"A Pre-Approval is a Pinch term for a stored payment method with approval from the customer for automatic payments. A Pre-Approval can be setup as unlimited or with a limit to only automatically pay invoices under a certain value."},"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"provider":"","settings":{}},"i18n":{"defaultLanguage":"en","languages":"en","state":"enabled"},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":{"type":"text-media","alignment":"left","side":"left","mediaType":"image","mediaImage":"https://files.readme.io/0bc1e89-Collect-payments.png","0bc1e89-Collect-payments.png",800,799,"#000000","6541832204bf50000b3df521","6541832204bf50000b3df521","title":"Our API allows you to:","text":"* Create and manage customers and payment methods\n* Charge customers for one-time or recurring payments\n* Manage plans and subscriptions\n* Handle refunds, disputes, and webhooks\n* Access reports and analytics"},{"type":"text","alignment":"left","text":"To get started, you will need a Pinch Payments account and an API key. You can sign up for a free developer account here(https://auth.getpinch.com.au/Register) and get your API key from the dashboard.\n\nOur API is RESTful and uses JSON for requests and responses. You can use any programming language or tool that supports HTTP requests to interact with our API. We also provide SDKs for some popular languages to make your integration easier."},{"type":"text-media","alignment":"left","side":"right","mediaType":"image","mediaImage":"https://files.readme.io/c482d9b-Artwork.png","c482d9b-Artwork.png",400,400,"#000000","654183251da49b00717c0352","654183251da49b00717c0352","title":"In this documentation, you will find:","text":"* Getting started guides to help you make your first API call for working with Credit Card(https://docs.getpinch.com.au/docs/credit-card-payments) or Direct Debit(https://docs.getpinch.com.au/docs/direct-debit-payments)\n* A reference section(https://docs.getpinch.com.au/reference) with detailed information on each API endpoint and parameter\n* Code examples in various languages to show you how to use our SDKs"},{"type":"text","alignment":"left","text":"We hope you enjoy using our API and we look forward to hearing your feedback. If you have any questions or need any help, please contact support(https://helpdesk.getpinch.com.au/kb-tickets/new)."},{"type":"docs","alignment":"left","pageType":"Documentation"},"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"thumbsEnabled":true,"planLimit":1000000,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"reference":true,"suggested_edits":false,"discuss":false,"docs":true,"examples":true,"landing":true,"changelog":false,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"name":"Pinch","nav_names":{"discuss":"","docs":"Guides","reference":"API Reference","changelog":"Changelog","tutorials":"","recipes":""},"oauth_url":"https://auth.getpinch.com.au/readme","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":true,"api":true,"logs":true,"domain":true,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""},"newExperience":false,"exampleQuestions":{"question1":"","question2":"","question3":""},"llmOptions":{"model":{}},"modelList":,"knowledge":""},"owner":{"id":"5719fed74604d417003d2692","email":null,"name":null},"plan":"startup","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"startup","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":false,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":false,"points":1},"integrations":{"enabled":true,"points":2}},"percentScore":50,"totalScore":153},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":true,"defaultExpandResponseSchema":true,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"60923d14b335c2004207fa9b","version":"2020.1","version_clean":"2020.1.0","codename":"v2020.1 (latest)","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":"60923d14b335c2004207fa65","60923d14b335c2004207fa66","60923d14b335c2004207fa67","5792943279215d1900324369","60923d14b335c2004207fa68","60923d14b335c2004207fa69","59070e3e46a5060f00873807","60923d14b335c2004207fa6a","60923d14b335c2004207fa6b","60923d14b335c2004207fa6c","60923d14b335c2004207fa6d","60923d14b335c2004207fa6e","60923d14b335c2004207fa6f","608b4c2d821651000f29ceca","6090877e0b2f70006c754f8d","60923de7d6fdda00796af202","60923e443d40bc003a1934fb","609259d278d83b004c1bafc3","60925ba3f7ee500010f0a98c","609a138a995901001f4f8ef2","6376bf00127d99000316c0db","654d8b5c06065a006ca42e63","655bf48077c4110039dafab9","657664a28afb7a00185913e6","65d1d59100d31c0010e6a8d6","66cfb09b8e7fb7000f9ed501","66cfb0f1ff718e00423426b8","677dcd44cc232400541f270a","681802d6faaf9e005c19dd30","__v":1,"project":"5719ff086346850e0083425e","forked_from":"5cd22c56ab51080063ef3146","createdAt":"2016-04-22T10:38:00.740Z","releaseDate":"2016-04-22T10:38:00.740Z","updatedAt":"2025-06-09T09:56:42.953Z","apiRegistries":{"filename":"pinch-api-depreciated.json","uuid":"wdxx2nmbc94u5x"},{"filename":"pinch-oauth-api-depreciated.json","uuid":"1mld74kq6wj7qs"},{"filename":"authentication-api.json","uuid":"19cwx91ailoh8663g"},{"filename":"pinch-api.json","uuid":"c9d18rv1clxisi0p1"},"pdfStatus":"","source":"readme"},"subdomain":"getpinch","subpath":"","superHubWaitlist":false,"topnav":{"left":{"type":"docs","text":"Guides"},{"type":"reference","text":"API Reference"},{"type":"url","text":"Pinch Website","url":"https://getpinch.com.au/"},"right":{"type":"url","text":"Pinch Portal","url":"https://web.getpinch.com.au"},{"type":"user","text":"User","url":"/login?redirect_uri/"},"edited":true,"bottom":},"trial":{"trialDeadlineEnabled":false,"trialEndsAt":"2020-04-14T03:31:40.196Z"},"translate":{"languages":,"provider":"transifex","key_public":"","org_name":"","project_name":"","show_widget":false},"url":"https://getpinch.com.au","versions":{"_id":"5719ff086346850e00834261","codename":"v2017.2 (deprecated)","hasDoc":true,"is_deprecated":true,"is_stable":false,"__v":13,"hasReference":true,"version_clean":"2017.2.0","categories":"5719ff086346850e00834262","5790ca1e8242580e00fc2b10","5790cd77f7ff000e004ba3cd","5792943279215d1900324369","57aaec7ff68f6e1900a8aae1","587205062b25e61900755484","59070e3e46a5060f00873807","5907145a0c4a590f007c900c","5909dee71d980c0f00525751","591c50384588a8190028489a","5b616037d76ae800031221fc","5b6252822b06be0003ea320f","6376bf00127d99000316c0dd","createdAt":"2016-04-22T10:38:00.740Z","is_beta":false,"is_hidden":false,"project":"5719ff086346850e0083425e","releaseDate":"2016-04-22T10:38:00.740Z","version":"2017.2","updatedAt":"2025-06-09T09:57:02.364Z","apiRegistries":{"filename":"pinch-api.json","uuid":"1mld74kq6uxppl"},{"filename":"authentication.json","uuid":"1mld74kq6uxqct"},"pdfStatus":"","source":"readme"},{"_id":"5cd22c56ab51080063ef3146","__v":3,"project":"5719ff086346850e0083425e","forked_from":"5719ff086346850e00834261","createdAt":"2016-04-22T10:38:00.740Z","releaseDate":"2016-04-22T10:38:00.740Z","categories":"5cd22c56ab51080063ef311f","5cd22c56ab51080063ef3120","5cd22c56ab51080063ef3121","5792943279215d1900324369","5cd22c56ab51080063ef3122","5cd22c56ab51080063ef3123","59070e3e46a5060f00873807","5cd22c56ab51080063ef3124","5cd22c56ab51080063ef3125","5cd22c56ab51080063ef3126","5cd22c56ab51080063ef3127","5cd22c56ab51080063ef3128","5e336833cbd9a8003a3da02c","608b4c2d821651000f29ceca","6090877e0b2f70006c754f8d","6376bf00127d99000316c0dc","is_deprecated":true,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"v2019.1 (deprecated)","version_clean":"2019.1.0","version":"2019.1","updatedAt":"2025-06-09T09:56:53.078Z","apiRegistries":{"filename":"pinch-api.json","uuid":"1mld74kq6vu283"},{"filename":"pinch-oauth-api.json","uuid":"1mld74kq6w7vb8"},{"filename":"authentication-api.json","uuid":"1mld74kq6w7vf6"},"pdfStatus":"","source":"readme"},{"_id":"60923d14b335c2004207fa9b","version":"2020.1","version_clean":"2020.1.0","codename":"v2020.1 (latest)","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":"60923d14b335c2004207fa65","60923d14b335c2004207fa66","60923d14b335c2004207fa67","5792943279215d1900324369","60923d14b335c2004207fa68","60923d14b335c2004207fa69","59070e3e46a5060f00873807","60923d14b335c2004207fa6a","60923d14b335c2004207fa6b","60923d14b335c2004207fa6c","60923d14b335c2004207fa6d","60923d14b335c2004207fa6e","60923d14b335c2004207fa6f","608b4c2d821651000f29ceca","6090877e0b2f70006c754f8d","60923de7d6fdda00796af202","60923e443d40bc003a1934fb","609259d278d83b004c1bafc3","60925ba3f7ee500010f0a98c","609a138a995901001f4f8ef2","6376bf00127d99000316c0db","654d8b5c06065a006ca42e63","655bf48077c4110039dafab9","657664a28afb7a00185913e6","65d1d59100d31c0010e6a8d6","66cfb09b8e7fb7000f9ed501","66cfb0f1ff718e00423426b8","677dcd44cc232400541f270a","681802d6faaf9e005c19dd30","__v":1,"project":"5719ff086346850e0083425e","forked_from":"5cd22c56ab51080063ef3146","createdAt":"2016-04-22T10:38:00.740Z","releaseDate":"2016-04-22T10:38:00.740Z","updatedAt":"2025-06-09T09:56:42.953Z","apiRegistries":{"filename":"pinch-api-depreciated.json","uuid":"wdxx2nmbc94u5x"},{"filename":"pinch-oauth-api-depreciated.json","uuid":"1mld74kq6wj7qs"},{"filename":"authentication-api.json","uuid":"19cwx91ailoh8663g"},{"filename":"pinch-api.json","uuid":"c9d18rv1clxisi0p1"},"pdfStatus":"","source":"readme"},"variableDefaults":,"webhookEnabled":true,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","canonical_url":null,"default_version":{"name":"2020.1"},"description":"Pinch Payments is a simple and secure way to accept online payments from your customers. With our API, you can integrate Pinch Payments into your website or app and start accepting payments in minutes.","git":{"connection":{"repository":{"full_name":"PinchPayments/docs","name":"docs","provider_type":"github","url":"https://github.com/PinchPayments/docs","privacy":{"private":true,"visibility":"internal"}},"organization":{"name":"PinchPayments","provider_type":"github"},"status":"active"}},"glossary":{"_id":"685024195aa634005f24dedb","term":"Pre-Approval","definition":"A Pre-Approval is a Pinch term for a stored payment method with approval from the customer for automatic payments. A Pre-Approval can be setup as unlimited or with a limit to only automatically pay invoices under a certain value."},"homepage_url":"https://getpinch.com.au","id":"5719ff086346850e0083425e","name":"Pinch","parent":null,"redirects":,"sitemap":"disabled","llms_txt":"disabled","subdomain":"getpinch","suggested_edits":"disabled","uri":"/projects/me","variable_defaults":,"webhooks":,"api_designer":{"allow_editing":"enabled"},"custom_login":{"jwt_expiration_time":0,"login_url":"https://auth.getpinch.com.au/readme","logout_url":null},"features":{"mdx":"enabled"},"mcp":{"custom_tools":,"disabled_routes":,"disabled_tools":},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":true,"metricsSDK":false},"pages":{"not_found":null,"default_visibility":"public"},"privacy":{"openapi":"admin","password":null,"view":"public"},"refactored":{"status":"enabled","migrated":"successful"},"seo":{"overwrite_title_tag":"disabled"},"metrics":{"monthly_purchase_limit":0},"feature_rules":{"merge":{}},"plan":{"type":"startup","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2020-04-14T03:31:40.196Z"}},"reference":{"api_sdk_snippets":"disabled","defaults":"always_use","json_editor":"disabled","method_badge_style":"classic","oauth_flows":"disabled","request_history":"enabled","response_examples":"expanded","response_schemas":"expanded","show_method_in_sidebar":"enabled","sdk_snippets":{"external":"disabled"}},"ai":{"owlbot":{"enabled":false},"chat":{"models":,"knowledge":{"custom_knowledge":null,"use_project_knowledge":false}}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"postman":{"key":null,"client_id":null,"client_secret":null,"is_connected":false},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"speakeasy":{"key":null,"spec_url":null},"stainless":{"key":null,"name":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":"enabled","html":"disabled","js":"disabled"}},"branches":{"merge":{"admin":true,"editor":false},"approve":{"admin":true,"editor":false}}},"appearance":{"brand":{"primary_color":"#311B92","link_color":"#FF5263","theme":"light"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"layout":{"full_width":"disabled","style":"classic"},"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":"https://files.readme.io/482d331-Pinch_logo_2021_white.svg","name":"482d331-Pinch_logo_2021_white.svg","width":300,"height":75,"color":"#000000","links":{"original_url":null}},"main":{"uri":null,"url":"https://files.readme.io/4aebab6-Pinch_logo_2021.svg","name":"4aebab6-Pinch_logo_2021.svg","width":161,"height":40,"color":"#ff5263","links":{"original_url":null}},"favicon":{"uri":null,"url":"https://files.readme.io/91e753c-small-favicon-32x32.png","name":"91e753c-small-favicon-32x32.png","width":32,"height":32,"color":"#000000","links":{"original_url":"https://files.readme.io/b7d4d68-favicon-32x32.png"}}},"custom_code":{"css":".rm-LandingPage ul {\n list-style: initial!important;\n padding-left: 2em!important; \n}","js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"solid","gradient_color":null,"link_style":"buttons","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}}}},"ai":{"dropdown":"enabled","options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","view_as_markdown":"enabled","ask_ai":"disabled"}},"navigation":{"breadcrumbs":"disabled","first_page":"landing_page","left":{"type":"guides","title":null,"url":null,"custom_page":null},{"type":"reference","title":null,"url":null,"custom_page":null},{"type":"link_url","title":"Pinch Website","url":"https://getpinch.com.au/","custom_page":null},"logo_link":"landing_page","page_icons":"enabled","right":{"type":"link_url","title":"Pinch Portal","url":"https://web.getpinch.com.au","custom_page":null},{"type":"user_controls","title":null,"url":null,"custom_page":null},"sub_nav":,"subheader_layout":"links","version":"enabled","links":{"home":{"label":"Home","visibility":"enabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":"Guides","visibility":"enabled"},"reference":{"label":"API Reference","alias":"API Reference","visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":"Changelog","visibility":"disabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}},"i18n":{"languages":"en","defaultLanguage":"en","state":"disabled"}}},"version":{"_id":"60923d14b335c2004207fa9b","version":"2020.1","version_clean":"2020.1.0","codename":"v2020.1 (latest)","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":"60923d14b335c2004207fa65","60923d14b335c2004207fa66","60923d14b335c2004207fa67","5792943279215d1900324369","60923d14b335c2004207fa68","60923d14b335c2004207fa69","59070e3e46a5060f00873807","60923d14b335c2004207fa6a","60923d14b335c2004207fa6b","60923d14b335c2004207fa6c","60923d14b335c2004207fa6d","60923d14b335c2004207fa6e","60923d14b335c2004207fa6f","608b4c2d821651000f29ceca","6090877e0b2f70006c754f8d","60923de7d6fdda00796af202","60923e443d40bc003a1934fb","609259d278d83b004c1bafc3","60925ba3f7ee500010f0a98c","609a138a995901001f4f8ef2","6376bf00127d99000316c0db","654d8b5c06065a006ca42e63","655bf48077c4110039dafab9","657664a28afb7a00185913e6","65d1d59100d31c0010e6a8d6","66cfb09b8e7fb7000f9ed501","66cfb0f1ff718e00423426b8","677dcd44cc232400541f270a","681802d6faaf9e005c19dd30","__v":1,"project":"5719ff086346850e0083425e","forked_from":"5cd22c56ab51080063ef3146","createdAt":"2016-04-22T10:38:00.740Z","releaseDate":"2016-04-22T10:38:00.740Z","updatedAt":"2025-06-09T09:56:42.953Z","apiRegistries":{"filename":"pinch-api-depreciated.json","uuid":"wdxx2nmbc94u5x"},{"filename":"pinch-oauth-api-depreciated.json","uuid":"1mld74kq6wj7qs"},{"filename":"authentication-api.json","uuid":"19cwx91ailoh8663g"},{"filename":"pinch-api.json","uuid":"c9d18rv1clxisi0p1"},"pdfStatus":"","source":"readme"}},"i18n":{"language":"en","translations":{"en":{"common":{"ai":{"aiOpenFailed":"Failed to open SuperHub AI panel.","askAi":"Ask AI","askAiAriaLabel":"Open Ask AI Assistant","mdCopy":"Copy Markdown","mdOpenFailed":"Failed to open as markdown","mdView":"View as Markdown","noMdToCopy":"No markdown content available to copy.","openFailed":"Failed to open {{option}}."},"apiConfig":{"allRequests":"All Requests","allRequestsFilter":"All Requests","apiKeysNotFound":"No API keys found.","apiKeysNotSynced":"API keys are not synced with this developer hub.","apiRequests":"API Requests","authentication":"Authentication","credentials":"Credentials","dayFilter":"Last 24 Hours","emptyStatePrompt":"Make a request to see them here or <a>Try It</a>!","error":"Error","errorRequestsFilter":"400 & 500","gettingStarted":"Getting Started","logInPrompt":"Log in to see your API keys","monthFilter":"Last 30 Days","moreErrors":"More Errors","moreRequests":"More Requests","myRecentErrors":"My Recent Errors","myRecentRequests":"My Recent Requests","myRequests":"My Requests","myTopEndpoints":"My Top Endpoints","personalizedDocsSetup":"Set up <Button>Personalized Docs</Button> to show users their API keys.","pickALanguage":"Pick a language","popularEndpoints":"Popular Endpoints","success":"Success","weekFilter":"Past week","yourApiKeys":"Your API Keys"},"attribution":"by {{attribution}}","auth":{"any":"any","apiKey":"API Key","apiKeyPrompt":"Get API Key","apiKeyShow":"Show API Key","apiKeyHide":"Hide API Key","apiKeyToggle":"Toggle API Key","apiInfo":"API Info","authenticate":"Authenticate","authorize":"Authorize","authorizationUrl":"Authorization URL","authorizedScopes":"Authorized scopes for this token","authorizedScopesEmpty":"Token has no authorized scopes","bearer":"Bearer","clientId":"Client ID","credentialMessage":"{{projectName}} accepts {{count}} credential methods. You can use {{option}} of them.","credentialsFor":"Credentials for {{name}}","credentialsForMd":"Credentials for `{{name}}`","either":"eitherLog in to use your API keys","grantType":"Grant Type","info":{"base64":"Your username and password will be combined with a : to form a base64-encoded string: `ENCODED_TOKEN`","basic":"Your username and password are being sent in the header(https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) of the request.","bearer":"\n Bearer authentication gives access to the “bearer of the token” and must be sent in the Authorization header. For example:\n ```bash\n curl --request POST \\\n --url https://httpbin.org/anything/bearer\n --header Authorization: Bearer BEARER_TOKEN\n ```\n ","cookie":"Your API Key is being sent as a cookie(https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies).","header":"Your API Key is sent in the request header(https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers).","jwt":"The bearer tokens format is JSON Web Token (JWT). Read more at JWT.io(https://jwt.io/).","query":"Your API Key is being sent as a query parameter in the URL(https://developer.mozilla.org/en-US/docs/Web/API/URL)."},"infoTable":{"contact":"Contact","description":"Description","identifier":"Identifier","license":"License","name":"Name","termsOfService":"Terms of Service","title":"Title","summary":"Summary","url":"URL","version":"Version"},"information":"Information","label":"Label","lastUsed":"Last Used","logInPrompt":"Log in to use your API keys","logOut":"Log Out","password":"password","passwordHideLabel":"Hide","passwordShowLabel":"Show","reAuthorize":"Re-Authorize","required":"required","requiredScopes":"Required Scopes","requiredScopesMissingMsg_one":"Missing {{count}} required scope","requiredScopesMissingMsg_other":"Missing {{count}} required scopes","scopes":"Scopes","scopesMissingCount":"({{count}} missing from this token)","scopesMissingMsg_one":"This operation requires {{count}} additional scope","scopesMissingMsg_other":"This operation requires {{count}} additional scopes","scopesRequiredMsg":"Scopes required for this operation","scopesRequiredNoneMsg":"No scopes required for this operation","selectCredentials":"Select Credentials","token":"token","tokenDetails":"Token Details","tokenRotationMessage":"We recommend you rotate this token.","tokenUrl":"Token URL","useOwnToken":"Use Your Own Token","username":"username"},"close":"Close","changelog":{"added":"Added","deprecated":"Deprecated","fixed":"Fixed","improved":"Improved","removed":"Removed","title":"Changelog"},"copyToClipboard":{"copiedFull":"Copied to clipboard!","copiedShort":"Copied!","copyFull":"Copy to clipboard","copyShort":"Copy","failed":"Failed to copy to clipboard.","unable":"Unable to copy"},"discussions":{"addCommentLabel":"Add Comment","adminLabel":"Admin","answered":"Answered","askQuestion":"Ask a Question","backToAll":"Back to all","blankBodyError":"Your post body cannot be blank.","blankCommentError":"Your comment cannot be blank.","blankPostError":"Your post cannot be blank.","blankTitleError":"Your post title cannot be blank.","cancelButtonLabel":"Cancel","commentAndMarkAnswered":"Comment and mark answered","commentAndReopen":"Comment and reopen","deleteButtonLabel":"Delete","deleteCommentConfirmation":"Are you sure you want to delete this comment?","deleteCommentPermanentConfirmation":"Are you sure you want to permanently delete this comment?","deleteComentSuccess":"This comment has been deleted","deletePermanentlyButtonLabel":"Permanently Delete","deletePostConfirmation":"Are you sure you want to delete this post?","editButtonLabel":"Edit","editedLabel":"edited","emailInputAriaLabel":"name@email.com","emailInputPlaceholder":"Your Email","errorMessagePrefix":"Error:","faqAddLabel":"Add to FAQ","faqRemoveLabel":"Remove from FAQ","faqsLabel":"FAQs","logInToComment":"<b>Log in</b> to add a comment.","markAsAnswered":"Mark as answered","markAsUnanswered":"Mark as unanswered","markCommentSpamLabel":"Mark this comment as spam","markPostSpamLabel":"Mark this post as spam","nameAndEmailError":"Please fill out your name and email.","nameInputAriaLabel":"Your name","nameInputPlaceholder":"Full name","permanentlyDeleteLabel":"Permanently delete","questionInputAriaLabel":"New question","recaptchaInvalidError":"Invalid ReCaptcha tokens.","recaptchaRequiredError":"Please complete the reCaptcha verification.","recentLabel":"Recent","saveButtonLabel":"Save","submitButtonLabel":"Post Question","tagButtonLabel":"Tag","tagInputPlaceholder":"Enter tag","titleInputAriaLabel":"Question title","titleInputPlaceholder":"Your question title","unansweredLabel":"Unanswered","voteCountLabel":"{{count}} vote","voteCountLabel_plural":"{{count}} votes"},"emptyState":{"changelog":{"title":"No Changelogs"},"discussion":{"actionLabel":"New Question","description":"Nobodys asked a question yet. Be the first!","title":"No Discussions"},"guide":{"title":"No Guides"},"recipe":{"title":"No Recipes"},"reference":{"title":"No API Endpoints"}},"more":"more…","next":"Next","onlyVisibleToAdmins":"Only visible to ReadMe admins","owlbotChat":{"assistant":"Assistant","clearChat":"Clear chat history","closeChat":"Close chat","emptyMessage":"I’ll help you find answers in the docs","emptyTitle":"Ask AI","failureTitle":"Ask AI","fallbackHeading":"Something went wrong with Ask AI","fallbackMessage":"Please try refreshing the page or contact support if the problem persists.","inputPlaceholder":"Ask a question","sendFailure":"Failed to send message. Please try again.","tryAgain":"Try Again","typingLabel":"Generating","voteFailure":"Failed to record vote. It may take a moment for the message to be saved. Please try again.","voteLabelDown":"Not helpful","voteLabelUp":"Helpful"},"pageNotFound":{"heading":"Page Not Found","metaTitle":"404 Not Found"},"pageThumbs":{"no":"No","placeHolder":"Leave an optional comment…","prompt":"Did this page help you?","submit":"Vote","thankYou":"Thanks for voting!","yes":"Yes"},"poweredBy":"Powered by","recipes":{"inThisRecipe":"In this Recipe","openRecipe":"Open Recipe","step_one":"{{count}} step","step_other":"{{count}} steps"},"reference":{"callback":"Callback","clearExample":"Clear Example","clearResponse":"Clear Response","data":"Data","example":"Example","examplePrompt":"Choose an example","examplePromptOr":"Or choose an example","examples":"Examples","headers":"Headers","invalidJSON":"Invalid JSON","inspectRequest":"Inspect Request","jsonEditorAriaLabel":"Toggle Raw JSON Editor","jsonEditorLabel":"Edit JSON Body","language":"Language","library":"Library","log":"Log","logsLoading":"Retrieving recent requests…","logsPrompt":"Make a request to see history.","logsSeeAllLabel":"See All Requests","logsStatusLabel":"Status","logsThisMonth_one":"{{count}} Request This Month","logsThisMonth_other":"{{count}} Requests This Month","logsTimeLabel":"Time","logsUserAgentLabel":"User Agent","payloadExample":"Payload Example","recentRequests":"Recent Requests","replayRequest":"Replay Request","request":"Request","requestExample":"Request Example","requestExamples":"Request Examples","requestHistoryPrompt":"Log in to see full request history","requestInstructions":"Request instructions","resetBody":"Reset Body","response":"Response","sdkCodeEmpty":"No SDK code available","sdkCodeError":"Error retrieving SDK code. Please try again later.","tryIt":"Try It","tryItPrompt":"Click <code>Try It!</code> to start a request and see the response here!","tryItPunctuated":"Try It!"},"search":{"askFailure":"We had an issue responding, please try again later","filtersLabel":"Filters","filtersPlaceholder":"Filter","forMore":"for more","fromTheDocs":"From the Docs","noResults":"No search results for","placeholder":"Search","pressEnterToAskAi":"Press <kbd>Enter</kbd> to ask AI","promptEmpty":"Start typing to search…","promptLoading":"Keep typing to search…","searching":"Searching…","thinking":"Thinking"},"sections":{"all":"All","apiLogs":"API Logs","changelog":"Changelog","discussions":"Discussions","guides":"Guides","graphql":"GraphQL","home":"Home","pages":"Pages","recipes":"Recipes","reference":"API Reference"},"tableOfContents":"Table of Contents","time":{"absolute":{"noPrefix":"{{time}}","noPrefixAttributed":"{{time}} by {{attribution}}","postedPrefix":"Posted {{time}}","postedPrefixAttributed":"Posted {{time}} by {{attribution}}","updatedPrefix":"Updated {{time}}","updatedPrefixAttributed":"Updated {{time}} by {{attribution}}"},"justNow":{"noPrefix":"Less than a minute ago","noPrefixAttributed":"Less than a minute ago by {{attribution}}","postedPrefix":"Posted just now","postedPrefixAttributed":"Posted just now by {{attribution}}","updatedPrefix":"Updated just now","updatedPrefixAttributed":"Updated just now by {{attribution}}"},"relative":{"noPrefix":"{{time}}","noPrefixAttributed":"{{time}} by {{attribution}}","postedPrefix":"Posted {{time}}","postedPrefixAttributed":"Posted {{time}} by {{attribution}}","updatedPrefix":"Updated {{time}}","updatedPrefixAttributed":"Updated {{time}} by {{attribution}}"}},"unableToCopy":"Unable to copy","version":{"beta":"Beta","default":"Default","deprecated":"Deprecated","hiddenLabel":"Hidden Version"},"whatsNext":"What’s Next"}}}},"is404":false,"isFramePreview":false,"isDetachedProductionSite":false,"lang":"en","langFull":"Default","reqUrl":"/","version":{"_id":"60923d14b335c2004207fa9b","version":"2020.1","version_clean":"2020.1.0","codename":"v2020.1 (latest)","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":"60923d14b335c2004207fa65","60923d14b335c2004207fa66","60923d14b335c2004207fa67","5792943279215d1900324369","60923d14b335c2004207fa68","60923d14b335c2004207fa69","59070e3e46a5060f00873807","60923d14b335c2004207fa6a","60923d14b335c2004207fa6b","60923d14b335c2004207fa6c","60923d14b335c2004207fa6d","60923d14b335c2004207fa6e","60923d14b335c2004207fa6f","608b4c2d821651000f29ceca","6090877e0b2f70006c754f8d","60923de7d6fdda00796af202","60923e443d40bc003a1934fb","609259d278d83b004c1bafc3","60925ba3f7ee500010f0a98c","609a138a995901001f4f8ef2","6376bf00127d99000316c0db","654d8b5c06065a006ca42e63","655bf48077c4110039dafab9","657664a28afb7a00185913e6","65d1d59100d31c0010e6a8d6","66cfb09b8e7fb7000f9ed501","66cfb0f1ff718e00423426b8","677dcd44cc232400541f270a","681802d6faaf9e005c19dd30","__v":1,"project":"5719ff086346850e0083425e","forked_from":"5cd22c56ab51080063ef3146","createdAt":"2016-04-22T10:38:00.740Z","releaseDate":"2016-04-22T10:38:00.740Z","updatedAt":"2025-06-09T09:56:42.953Z","apiRegistries":{"filename":"pinch-api-depreciated.json","uuid":"wdxx2nmbc94u5x"},{"filename":"pinch-oauth-api-depreciated.json","uuid":"1mld74kq6wj7qs"},{"filename":"authentication-api.json","uuid":"19cwx91ailoh8663g"},{"filename":"pinch-api.json","uuid":"c9d18rv1clxisi0p1"},"pdfStatus":"","source":"readme"},"gitVersion":{"base":"2019.1","display_name":"v2020.1 (latest)","i18n":{"lang":null,"parsed_version":null},"name":"2020.1","release_stage":"release","source":"readme","state":"current","updated_at":"2026-01-07T10:59:21.000Z","uri":"/branches/2020.1","privacy":{"view":"default"}},"versions":{"total":3,"data":{"base":null,"display_name":"v2017.2 (deprecated)","i18n":{"lang":null,"parsed_version":null},"name":"2017.2","release_stage":"release","source":"readme","state":"deprecated","updated_at":"2025-06-09T07:06:51.826Z","uri":"/branches/2017.2","privacy":{"view":"public"}},{"base":"2017.2","display_name":"v2019.1 (deprecated)","i18n":{"lang":null,"parsed_version":null},"name":"2019.1","release_stage":"release","source":"readme","state":"deprecated","updated_at":"2025-06-09T07:07:18.366Z","uri":"/branches/2019.1","privacy":{"view":"public"}},{"base":"2019.1","display_name":"v2020.1 (latest)","i18n":{"lang":null,"parsed_version":null},"name":"2020.1","release_stage":"release","source":"readme","state":"current","updated_at":"2026-01-07T10:59:21.233Z","uri":"/branches/2020.1","privacy":{"view":"default"}},"type":"version"}}>/script>/div>div idhub-container>div classhub-container>div state-container ng-attr-id{{state.current().root ! docs && react-app-content-container}}>div idreplace-view ng-non-bindable>/div>/div>/div>/div>script>var is_hub true;var is_hub2 true;var is_hub_edit true;/script>div idssr-end>script id__LOADABLE_REQUIRED_CHUNKS__ typeapplication/json>32852,44863,21456,13766,46123,23781,48424,16563,6146,65492,99947,6349,45496,68075,28788,31165,73678,63859,88836,58577,13221,87327,69274,45798/script>script id__LOADABLE_REQUIRED_CHUNKS___ext typeapplication/json>{namedChunks:routes-SuperHub,Containers-EndUserContainer,Header,RDMD,core-icons-chevron-down-svg,SuperHubSearch,core-icons-search-svg,core-icons-custom-pages-svg,Home,Footer}/script>script async data-chunkmain srchttps://cdn.readme.io/public/hub/web/main.3b129c8ad16910742dc7.js>/script>script async data-chunkroutes-SuperHub srchttps://cdn.readme.io/public/hub/web/routes-SuperHub.e22f1bc7bff0d7e98787.js>/script>script async data-chunkContainers-EndUserContainer srchttps://cdn.readme.io/public/hub/web/Containers-EndUserContainer.b902e16b915b9acb54fb.js>/script>script async data-chunkHeader srchttps://cdn.readme.io/public/hub/web/Header.220751c4627e9950b2e1.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/13766.d772ba54efb1db56d529.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/46123.69ebc12c0e2bace354b5.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/23781.e74aa301646844cc6f02.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/48424.bb37c5885520ec98c35d.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/16563.8ee90e74136685c009f7.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/6146.f99bcbc8d654cc36d7c8.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/65492.cd2ee63fcdce46aab92a.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/99947.1ce5a0ee52c06ee3aa91.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/6349.ee60994ef05ee0495ab4.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/45496.29fc32790c0adc953776.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/68075.6b41bfeb2f8eb674bf52.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/28788.d39c04b94380b53a9531.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/31165.bac4906f0f0787b49938.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/RDMD.b594f093c77c152b86d9.js>/script>script async data-chunkcore-icons-chevron-down-svg srchttps://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.1500d4048db301af0f24.js>/script>script async data-chunkSuperHubSearch srchttps://cdn.readme.io/public/hub/web/88836.466db83f0dbc8536e6f1.js>/script>script async data-chunkSuperHubSearch srchttps://cdn.readme.io/public/hub/web/SuperHubSearch.b20875374c8ca8654670.js>/script>script async data-chunkcore-icons-search-svg srchttps://cdn.readme.io/public/hub/web/core-icons-search-svg.188b3766d12ac3a86b64.js>/script>script async data-chunkcore-icons-custom-pages-svg srchttps://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.4af85e07cd1067d86542.js>/script>script async data-chunkHome srchttps://cdn.readme.io/public/hub/web/Home.9928b6aea1adc23067fa.js>/script>script async data-chunkFooter srchttps://cdn.readme.io/public/hub/web/Footer.1371fb0e905b592fbec6.js>/script>/div>script asyncasync srchttps://www.googletagmanager.com/gtag/js?idG-5XRJ55ZY2Q>/script>script>window.dataLayer window.dataLayer || ;function gtag(){dataLayer.push(arguments);}gtag(js, new Date());gtag(config, G-5XRJ55ZY2Q);/script>script idhub-me typeapplication/json data-json{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"YjM4NGIwOTc4ZTNkMmM5MzdmZTdhYzcwOTMwZjUxNzExODVlM2FkNWVlNDVkMTliYzFiNDNjNjBkNzQzMWVhM3RhZ0ZpbHRlcnM9KHByb2plY3Q6NTcxOWZmMDg2MzQ2ODUwZTAwODM0MjVlKSwodmVyc2lvbjpub25lLHZlcnNpb246NjA5MjNkMTRiMzM1YzIwMDQyMDdmYTliKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ","filters":"tagFilters(project:5719ff086346850e0083425e),(version:none,version:60923d14b335c2004207fa9b),(hidden:none,hidden:false),(index:CustomPage,index:Page)","metaData":{"modules":{"reference":true,"suggested_edits":false,"discuss":false,"docs":true,"examples":true,"landing":true,"changelog":false,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"id":"5719ff086346850e0083425e","name":"Pinch","subdomain":"getpinch","subpath":"","nav_names":{"discuss":"","docs":"Guides","reference":"API Reference","changelog":"Changelog","tutorials":"","recipes":""}}}}>/script>script idreadme-data-baseUrl typeapplication/json data-json"/">/script>/body>/html>
View on OTX
|
View on ThreatMiner
Please enable JavaScript to view the
comments powered by Disqus.
Data with thanks to
AlienVault OTX
,
VirusTotal
,
Malwr
and
others
. [
Sitemap
]