Send your API Key in the API-Key header on every request. Keep your API Secret on your server to verify webhook signatures. It is never sent with a request.
API-Key Header
Include your API Key in the API-Key header for every API request:
API-Key: YOUR_API_KEY
You can find your API Key in your dashboard under Settings › API Keys.
Requests with a missing, invalid or revoked API-Key return 401 Unauthorized. A valid key used on a route its account type can’t access (for example, a sender key on a provider route) returns 403 Forbidden.
Do not commit your API keys to git, or use them in client-side code. Never share your API Secret. If you believe it has been compromised, rotate it immediately in your dashboard.
API Secret
Your API Secret is used for sensitive operations such as verifying webhook signatures and should never be shared or exposed in client-side code.
Keep your API Secret safe. The API Secret is for server-side use only (e.g., webhook signature verification). Never expose it in frontend code, public repositories, or logs.
Webhook Signature Verification
When receiving webhooks, use your API Secret to verify the authenticity of the payload. Refer to the webhook documentation for implementation details.
Always ensure your server verifies the SSL connection to Paycrest. Do not set SSL verification (e.g., VERIFY_PEER) to FALSE in your HTTP client.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Paycrest","colors":{"primary":"#3B82F6","light":"#F8FAFC","dark":"#0F172A"},"logo":{"light":"https://mintcdn.com/paycrest-ee534df1/1KJUqwVXLoIPJVij/logo/light.svg?fit=max\u0026auto=format\u0026n=1KJUqwVXLoIPJVij\u0026q=85\u0026s=c6db6fb90e95231160524cb515a51dd0","dark":"https://mintcdn.com/paycrest-ee534df1/1KJUqwVXLoIPJVij/logo/dark.svg?fit=max\u0026auto=format\u0026n=1KJUqwVXLoIPJVij\u0026q=85\u0026s=7f53003e64f81035e8f3a1faf6f380a1"},"favicon":"https://mintcdn.com/paycrest-ee534df1/1KJUqwVXLoIPJVij/logo/favicon.png?fit=max\u0026auto=format\u0026n=1KJUqwVXLoIPJVij\u0026q=85\u0026s=8711906a377765a909494b9fdd1f65a0","navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"},{"href":"https://github.com/paycrest","label":"GitHub"},{"href":"https://t.me/+Stx-wLOdj49iNDM0","label":"Community"}]},"footer":{"socials":{"x":"https://x.com/paycrest","github":"https://github.com/paycrest","linkedin":"https://www.linkedin.com/company/paycrest"}},"seo":{"metatags":{"base:app_id":"69f2113a05020c0316bbbf92"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paycrest-ee534df1","hasAudioNarration":false,"actualSubdomain":"paycrest-ee534df1","customDomains":["docs.paycrest.io"],"gitSource":{"type":"github","owner":"paycrest","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6afd9d9b921026410dbb2798","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API Reference","count":40},{"language":"default","tag":"Guides","count":17},{"language":"default","tag":"General","count":16},{"language":"default","tag":"Sender","count":12},{"language":"default","tag":"Provider","count":9},{"language":"default","tag":"Resources","count":5},{"language":"default","tag":"Core Concepts","count":4},{"language":"default","tag":"For Senders","count":4},{"language":"default","tag":"Overview","count":3},{"language":"default","tag":"Getting Started","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/authentication","slug":"/api-reference/authentication","pageMetadata":{"title":null,"description":null,"href":"/api-reference/authentication"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Send your `,_jsx(_components.strong,{children:`API Key`}),` in the `,_jsx(_components.code,{children:`API-Key`}),` header on every request. Keep your `,_jsx(_components.strong,{children:`API Secret`}),` on your server to verify webhook signatures. It is never sent with a request.`]}),`\n`,_jsx(Heading,{level:`2`,id:`api-key-header`,children:`API-Key Header`}),`\n`,_jsxs(_components.p,{children:[`Include your `,_jsx(_components.strong,{children:`API Key`}),` in the `,_jsx(_components.code,{children:`API-Key`}),` header for every API request:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`API-Key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` YOUR_API_KEY`})]}),`\n`]})})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`You can find your API Key in your dashboard under `,_jsx(_components.strong,{children:`Settings › API Keys`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Requests with a missing, invalid or revoked API-Key return `,_jsx(_components.strong,{children:`401 Unauthorized`}),`. A valid key used on a route its account type can’t access (for example, a sender key on a provider route) returns `,_jsx(_components.strong,{children:`403 Forbidden`}),`.`]}),`\n`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Do not commit your API keys to git, or use them in client-side code. Never share your API Secret. If you believe it has been compromised, rotate it immediately in your dashboard.`})}),`\n`,_jsx(Heading,{level:`2`,id:`api-secret`,children:`API Secret`}),`\n`,_jsxs(_components.p,{children:[`Your `,_jsx(_components.strong,{children:`API Secret`}),` is used for sensitive operations such as verifying webhook signatures and should `,_jsx(_components.strong,{children:`never`}),` be shared or exposed in client-side code.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Keep your API Secret safe. The API Secret is for server-side use only (e.g., webhook signature verification). Never expose it in frontend code, public repositories, or logs.`})}),`\n`,_jsx(Heading,{level:`2`,id:`webhook-signature-verification`,children:`Webhook Signature Verification`}),`\n`,_jsx(_components.p,{children:`When receiving webhooks, use your API Secret to verify the authenticity of the payload. Refer to the webhook documentation for implementation details.`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Always ensure your server verifies the SSL connection to Paycrest. Do not set SSL verification (e.g., `,_jsx(_components.code,{children:`VERIFY_PEER`}),`) to `,_jsx(_components.code,{children:`FALSE`}),` in your HTTP client.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":null,"description":null,"href":"/api-reference/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"API-Key Header","slug":"api-key-header","depth":2,"children":[]},{"title":"API Secret","slug":"api-secret","depth":2,"children":[]},{"title":"Webhook Signature Verification","slug":"webhook-signature-verification","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"paycrest-ee534df1","siteName":"Paycrest","title":"Authentication - Paycrest","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/authentication","matchLevel":0},"v1":{"href":"/api-reference/authentication","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T21:32:47.080Z","originalFileLocation":"api-reference/authentication.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Paycrest\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paycrest-ee534df1/NP63BVAIWeGufkEv/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/paycrest-ee534df1/NP63BVAIWeGufkEv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paycrest-ee534df1/NP63BVAIWeGufkEv/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paycrest-ee534df1/NP63BVAIWeGufkEv/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paycrest-ee534df1/NP63BVAIWeGufkEv/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paycrest-ee534df1/NP63BVAIWeGufkEv/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paycrest-ee534df1/NP63BVAIWeGufkEv/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paycrest-ee534df1/NP63BVAIWeGufkEv/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paycrest-ee534df1/NP63BVAIWeGufkEv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Paycrest\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paycrest\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paycrest.io/api-reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paycrest-ee534df1.mintlify.site/_mintlify/api/og/v2?division=Overview\u0026amp;title=Authentication\u0026amp;theme=0eb6d8922c2e7a499381c97b\u0026amp;signature=4eb9effe5909918b6499724fb1457e876a2e8bb81d982bfa79d62aef4960c43f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Authentication - Paycrest\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paycrest-ee534df1.mintlify.site/_mintlify/api/og/v2?division=Overview\u0026amp;title=Authentication\u0026amp;theme=0eb6d8922c2e7a499381c97b\u0026amp;signature=4eb9effe5909918b6499724fb1457e876a2e8bb81d982bfa79d62aef4960c43f\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/paycrest-ee534df1/NP63BVAIWeGufkEv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paycrest\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3B82F6\">\u003cmeta data-mint-head name=\"base:app_id\" content=\"69f2113a05020c0316bbbf92\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paycrest.io/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paycrest.io/#organization\",\"name\":\"Paycrest\",\"url\":\"https://docs.paycrest.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paycrest-ee534df1/1KJUqwVXLoIPJVij/logo/light.svg?fit=max\u0026auto=format\u0026n=1KJUqwVXLoIPJVij\u0026q=85\u0026s=c6db6fb90e95231160524cb515a51dd0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paycrest.io#website\",\"name\":\"Paycrest\",\"url\":\"https://docs.paycrest.io\",\"publisher\":{\"@id\":\"https://docs.paycrest.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paycrest.io/api-reference/authentication#webpage\",\"url\":\"https://docs.paycrest.io/api-reference/authentication\",\"name\":\"Authentication\",\"dateModified\":\"2026-11-16T21:32:47.080Z\",\"isPartOf\":{\"@id\":\"https://docs.paycrest.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paycrest.io/api-reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paycrest.io/api-reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Overview\",\"item\":\"https://docs.paycrest.io/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.paycrest.io/api-reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.paycrest.io/api-reference/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"url\":\"https://docs.paycrest.io/api-reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paycrest.io/api-reference/authentication#webpage\"},\"dateModified\":\"2026-11-16T21:32:47.080Z\",\"publisher\":{\"@id\":\"https://docs.paycrest.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paycrest.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paycrest\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Paycrest\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/authentication.md","siteName":"Paycrest","nav":{"global":null,"versions":[{"version":"v2","tag":"Latest","tabs":[{"tab":"Guides","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"},{"title":"Use Cases","href":"/concepts/use-cases"}]},{"group":"Core Concepts","pages":[{"title":"Protocol Participants","href":"/concepts/participants"},{"title":"Protocol Architecture","href":"/concepts/architecture"},{"title":"Compliance \u0026 Security","href":"/concepts/compliance-security"},{"title":"Transaction Lifecycle","href":"/concepts/transaction-lifecycle"}]},{"group":"For Senders","pages":[{"title":"Sender API Integration","href":"/implementation-guides/sender-api-integration"},{"title":"Smart Contract Interaction","href":"/implementation-guides/smart-contract-interaction"},{"title":"Sender Agent Guide","href":"/implementation-guides/sender-mcp"},{"title":"Code Standards","href":"/resources/code-standards"}]},{"group":"For Providers","pages":[{"title":"Provider Setup Guide","href":"/implementation-guides/provider-setup-guide"}]},{"group":"Resources","pages":[{"title":"Supported Stablecoins","href":"/resources/supported-stablecoins"},{"title":"Supported Currencies","href":"/resources/supported-currencies"},{"title":"Gateway Contract Addresses","href":"/resources/gateway-contract-addresses"},{"title":"Troubleshooting","href":"/resources/troubleshooting"},{"title":"Changelog","href":"/resources/changelog"}]}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Introduction","description":"API Reference for Paycrest. Explore endpoints, request/response formats, and integration details.","href":"/api-reference/introduction"},{"title":null,"href":"/api-reference/authentication"},{"title":null,"description":null,"href":"/api-reference/errors"}]},{"group":"Sender","pages":[{"title":"Initiate Order","openapi":"openapi-v2.yaml POST /sender/orders","href":"/api-reference/sender/initiate-payment-order-v2"},{"title":"List Orders","openapi":"openapi-v2.yaml GET /sender/orders","href":"/api-reference/sender/list-payment-orders-v2"},{"title":"Get Order by ID","openapi":"openapi-v2.yaml GET /sender/orders/{id}","href":"/api-reference/sender/get-payment-order-by-id-v2"},{"title":"Get Order Status by Gateway ID","openapi":"openapi-v2.yaml GET /orders/{chain_id}/{id}","href":"/api-reference/sender/get-order-by-gateway-id"},{"title":"Get Sender Stats","openapi":"openapi-v2.yaml GET /sender/stats","href":"/api-reference/sender/get-sender-stats"},{"title":"List Webhook Deliveries","openapi":"openapi-v2.yaml GET /sender/webhooks","href":"/api-reference/sender/list-webhook-deliveries"},{"title":"Get Webhook Delivery","openapi":"openapi-v2.yaml GET /sender/webhooks/{id}","href":"/api-reference/sender/get-webhook-delivery-by-id"},{"title":"Retry Webhook Delivery","openapi":"openapi-v2.yaml POST /sender/webhooks/{id}/retry","href":"/api-reference/sender/retry-webhook-delivery"}]},{"group":"Provider","pages":[{"title":"List Orders","openapi":"openapi-v2.yaml GET /provider/orders","href":"/api-reference/provider/list-orders-v2"},{"title":"Get Order by ID","openapi":"openapi-v2.yaml GET /provider/orders/{id}","href":"/api-reference/provider/get-order-by-id-v2"},{"title":"Get Market Rate","openapi":"openapi-v2.yaml GET /provider/rates/{token}/{fiat}","href":"/api-reference/provider/get-market-rate"},{"title":"Get Provider Stats","openapi":"openapi-v2.yaml GET /provider/stats","href":"/api-reference/provider/get-provider-stats"},{"title":"Get Node Info","openapi":"openapi-v2.yaml GET /provider/node-info","href":"/api-reference/provider/get-node-info"}]},{"group":"General","pages":[{"title":"List Supported Currencies","openapi":"openapi-v2.yaml GET /currencies","href":"/api-reference/general/list-supported-currencies"},{"title":"List Supported Institutions","openapi":"openapi-v2.yaml GET /institutions/{currency_code}","href":"/api-reference/general/list-supported-institutions"},{"title":"List Supported Tokens","openapi":"openapi-v2.yaml GET /tokens","href":"/api-reference/general/list-supported-tokens"},{"title":"Get Token Rate","openapi":"openapi-v2.yaml GET /rates/{network}/{from}/{amount}/{to}","href":"/api-reference/general/get-token-rate"},{"title":"Get Markets","openapi":"openapi-v2.yaml GET /markets","href":"/api-reference/general/get-markets"},{"title":"Get Aggregator Public Key","openapi":"openapi-v2.yaml GET /pubkey","href":"/api-reference/general/get-aggregator-public-key"},{"title":"Verify Account","openapi":"openapi-v2.yaml POST /verify-account","href":"/api-reference/general/verify-account"},{"title":"Reindex Transaction","openapi":"openapi-v2.yaml GET /reindex/{network}/{tx_hash_or_address}","href":"/api-reference/general/reindex-transaction"}]}]}]},{"version":"v1","tag":"Legacy","pages":[{"title":"v1","href":"/api-reference/introduction"}]}]},"basePath":"","title":"Authentication - Paycrest","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":[],"chunks":[]}