Ao exceder o rate limit, você receberá um erro 429 Too Many Requests com o header Retry-After indicando quando tentar novamente.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Upay Gateway API","colors":{"primary":"#9747FF","light":"#A78BFA","dark":"#5B21B6"},"logo":{"light":"https://mintcdn.com/upayltda/T5HX5GY5uXX2lZeM/logo/light.png?fit=max\u0026auto=format\u0026n=T5HX5GY5uXX2lZeM\u0026q=85\u0026s=8ffdc8c1eb32a44080e0b8b936694ab2","dark":"https://mintcdn.com/upayltda/T5HX5GY5uXX2lZeM/logo/dark.png?fit=max\u0026auto=format\u0026n=T5HX5GY5uXX2lZeM\u0026q=85\u0026s=7e62beef814a5e762974ae7eda4107bf"},"favicon":"https://mintcdn.com/upayltda/T5HX5GY5uXX2lZeM/favicon.ico?fit=max\u0026auto=format\u0026n=T5HX5GY5uXX2lZeM\u0026q=85\u0026s=e4ae1785485514cb2256facdcce51673","navbar":{"links":[{"href":"/llms.txt","label":"llms.txt"},{"href":"mailto:suporte@upay.com.br","label":"Suporte"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.upaybr.com"}},"footer":{"socials":{"github":"https://github.com/anthonymengottii/upay_sistema"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"upayltda","hasAudioNarration":false,"actualSubdomain":"upayltda","customDomains":["docs.upaybr.com"],"gitSource":{"type":"github","owner":"anthonymengottii","repo":"documentation_upay","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9447506335a12e04edf26:success","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Endpoints","count":69},{"language":"default","tag":"Documentação","count":56},{"language":"default","tag":"Afiliados","count":20},{"language":"default","tag":"Assinaturas","count":14},{"language":"default","tag":"Webhooks","count":13},{"language":"default","tag":"Comece Aqui","count":12},{"language":"default","tag":"Saques","count":12},{"language":"default","tag":"Produtos","count":11},{"language":"default","tag":"SDKs","count":10},{"language":"default","tag":"Links de Pagamento","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"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":"llms-txt-v2","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}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"::-webkit-scrollbar{width:10px;height:10px}::-webkit-scrollbar-track{background:#f1f1f1}::-webkit-scrollbar-thumb{background:#c1c1c1;border-radius:5px}::-webkit-scrollbar-thumb:hover{background:#a8a8a8}html[data-theme=\"dark\"] ::-webkit-scrollbar,.dark ::-webkit-scrollbar,[data-theme=\"dark\"] ::-webkit-scrollbar{width:10px;height:10px}html[data-theme=\"dark\"] ::-webkit-scrollbar-track,.dark ::-webkit-scrollbar-track,[data-theme=\"dark\"] ::-webkit-scrollbar-track{background:#1e1b24}html[data-theme=\"dark\"] ::-webkit-scrollbar-thumb,.dark ::-webkit-scrollbar-thumb,[data-theme=\"dark\"] ::-webkit-scrollbar-thumb{background:#5B21B6;border-radius:5px}html[data-theme=\"dark\"] ::-webkit-scrollbar-thumb:hover,.dark ::-webkit-scrollbar-thumb:hover,[data-theme=\"dark\"] ::-webkit-scrollbar-thumb:hover{background:#9747FF}*{scrollbar-width:thin;scrollbar-color:#c1c1c1 #f1f1f1}html[data-theme=\"dark\"] *,.dark *,[data-theme=\"dark\"] *{scrollbar-width:thin;scrollbar-color:#5B21B6 #1e1b24}"}],"page":{"pagePath":"pages/payment-links/reference","slug":"/pages/payment-links/reference","pageMetadata":{"title":"Referência","description":"Documentação completa da API de Links de pagamento","icon":"book","href":"/pages/payment-links/reference"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Documentação completa da API de Links de pagamento\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`links-de-pagamento`,children:`Links de pagamento`}),`\n`,_jsx(_components.p,{children:`Gerencie links de pagamento personalizados que podem ser compartilhados com seus clientes.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Para um guia completo sobre Links de pagamento, consulte `,_jsx(_components.a,{href:`/pages/guides/features/payment-links`,children:`Guia de Links de pagamento`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`endpoints-disponíveis`,children:`Endpoints disponíveis`}),`\n`,_jsx(Heading,{level:`3`,id:`endpoints-públicos-checkout`,children:`Endpoints públicos (Checkout)`}),`\n`,_jsx(_components.p,{children:`Estes endpoints são públicos e não requerem autenticação. São usados no checkout público:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Método`}),_jsx(_components.th,{children:`Endpoint`}),_jsx(_components.th,{children:`Descrição`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/payment-links/public/slug/{slug}`})}),_jsx(_components.td,{children:`Obter informações de um link de pagamento público`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`POST`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/payment-links/public/slug/{slug}/start`})}),_jsx(_components.td,{children:`Iniciar checkout (cria transação PENDING sem dados do cliente)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`POST`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/payment-links/public/slug/{slug}/checkout`})}),_jsx(_components.td,{children:`Criar checkout completo com dados do cliente`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/payment-links/public/transactions/{id}/status`})}),_jsx(_components.td,{children:`Consultar status de uma transação`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/payment-links/public/transactions/{id}/sync-status`})}),_jsx(_components.td,{children:`Sincronizar status consultando gateway diretamente`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`POST`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/payment-links/public/slug/{slug}/cart-abandonment`})}),_jsx(_components.td,{children:`Registrar abandono de carrinho (cliente não concluiu checkout)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`POST`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/payment-links/public/slug/{slug}/cart-abandonment/recover`})}),_jsx(_components.td,{children:`Marcar carrinho abandonado como recuperado (compra concluída)`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`endpoints-privados-api-v1`,children:`Endpoints privados (API v1)`}),`\n`,_jsx(_components.p,{children:`Estes endpoints requerem autenticação via API Key:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Método`}),_jsx(_components.th,{children:`Endpoint`}),_jsx(_components.th,{children:`Descrição`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`POST`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/v1/payment-links`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/pages/payment-links/create`,children:`Criar um novo link de pagamento`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/v1/payment-links`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/pages/payment-links/list`,children:`Listar links de pagamento`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/v1/payment-links/{id}`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/pages/payment-links/get`,children:`Obter link de pagamento específico`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`PATCH`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/v1/payment-links/{id}`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/pages/payment-links/update`,children:`Atualizar link de pagamento`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`DELETE`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/v1/payment-links/{id}`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/pages/payment-links/delete`,children:`Deletar link de pagamento`})})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`endpoints-privados-dashboard`,children:`Endpoints privados (Dashboard)`}),`\n`,_jsx(_components.p,{children:`Estes endpoints requerem autenticação via Bearer Token (JWT):`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Método`}),_jsx(_components.th,{children:`Endpoint`}),_jsx(_components.th,{children:`Descrição`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/payment-links`})}),_jsx(_components.td,{children:`Listar links de pagamento`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`POST`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/payment-links`})}),_jsx(_components.td,{children:`Criar link de pagamento`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/payment-links/{id}`})}),_jsx(_components.td,{children:`Obter link de pagamento`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`PATCH`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/payment-links/{id}`})}),_jsx(_components.td,{children:`Atualizar link de pagamento`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`PUT`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/payment-links/{id}`})}),_jsx(_components.td,{children:`Atualizar link de pagamento (alias)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`DELETE`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/api/payment-links/{id}`})}),_jsx(_components.td,{children:`Deletar link de pagamento`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`autenticação`,children:`Autenticação`}),`\n`,_jsx(Heading,{level:`3`,id:`endpoints-públicos`,children:`Endpoints públicos`}),`\n`,_jsx(_components.p,{children:`Não requerem autenticação. Apenas rate limiting por IP (100 requisições/minuto).`}),`\n`,_jsx(Heading,{level:`3`,id:`endpoints-api-v1`,children:`Endpoints API v1`}),`\n`,_jsx(_components.p,{children:`Requerem autenticação via Bearer Token (API Key):`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`Authorization:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Bearer`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` SUA_API_KEY`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`endpoints-dashboard`,children:`Endpoints Dashboard`}),`\n`,_jsx(_components.p,{children:`Requerem autenticação via Bearer Token (JWT):`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`Authorization:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Bearer`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` SEU_JWT_TOKEN`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://upay-sistema-api.onrender.com`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`rate-limits`,children:`Rate limits`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Tipo de endpoint`}),_jsx(_components.th,{children:`Limite`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Endpoints públicos`}),_jsx(_components.td,{children:`100 requisições/minuto por IP`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Endpoints autenticados`}),_jsx(_components.td,{children:`1000 requisições/minuto por API Key`})]})]})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Ao exceder o rate limit, você receberá um erro `,_jsx(_components.code,{children:`429 Too Many Requests`}),` com o header `,_jsx(_components.code,{children:`Retry-After`}),` indicando quando tentar novamente.`]})})]})}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":"Referência","description":"Documentação completa da API de Links de pagamento","icon":"book","href":"/pages/payment-links/reference"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Links de pagamento","slug":"links-de-pagamento","depth":2,"children":[]},{"title":"Endpoints disponíveis","slug":"endpoints-disponíveis","depth":2,"children":[{"title":"Endpoints públicos (Checkout)","slug":"endpoints-públicos-checkout","depth":3,"children":[]},{"title":"Endpoints privados (API v1)","slug":"endpoints-privados-api-v1","depth":3,"children":[]},{"title":"Endpoints privados (Dashboard)","slug":"endpoints-privados-dashboard","depth":3,"children":[]}]},{"title":"Autenticação","slug":"autenticação","depth":2,"children":[{"title":"Endpoints públicos","slug":"endpoints-públicos","depth":3,"children":[]},{"title":"Endpoints API v1","slug":"endpoints-api-v1","depth":3,"children":[]},{"title":"Endpoints Dashboard","slug":"endpoints-dashboard","depth":3,"children":[]}]},{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Rate limits","slug":"rate-limits","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"upayltda","siteName":"Upay Gateway API","title":"Referência - Upay Gateway API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-26T06:28:50.806Z","originalFileLocation":"pages/payment-links/reference.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=\"description\" content=\"Documentação completa da API de Links de pagamento\">\u003cmeta data-mint-head name=\"application-name\" content=\"Upay Gateway API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/upayltda/hTvrozCyst-c74ys/_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/upayltda/hTvrozCyst-c74ys/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/upayltda/hTvrozCyst-c74ys/_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/upayltda/hTvrozCyst-c74ys/_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/upayltda/hTvrozCyst-c74ys/_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/upayltda/hTvrozCyst-c74ys/_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/upayltda/hTvrozCyst-c74ys/_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/upayltda/hTvrozCyst-c74ys/_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/upayltda/hTvrozCyst-c74ys/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Referência - Upay Gateway API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Documentação completa da API de Links de pagamento\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Upay Gateway API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.upaybr.com/pages/payment-links/reference\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://upayltda.mintlify.site/_mintlify/api/og/v2?division=Link+de+pagamento\u0026amp;title=Refer%C3%AAncia\u0026amp;description=Documenta%C3%A7%C3%A3o+completa+da+API+de+Links+de+pagamento\u0026amp;theme=bf8ddb6409cb00b879af8b75\u0026amp;signature=43b85bfbecfc6c9f91cb5e56ecf7a667b01080d2f2d120fda7d40e2e74cfd35c\">\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=\"Referência - Upay Gateway API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Documentação completa da API de Links de pagamento\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://upayltda.mintlify.site/_mintlify/api/og/v2?division=Link+de+pagamento\u0026amp;title=Refer%C3%AAncia\u0026amp;description=Documenta%C3%A7%C3%A3o+completa+da+API+de+Links+de+pagamento\u0026amp;theme=bf8ddb6409cb00b879af8b75\u0026amp;signature=43b85bfbecfc6c9f91cb5e56ecf7a667b01080d2f2d120fda7d40e2e74cfd35c\">\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/upayltda/hTvrozCyst-c74ys/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Upay Gateway API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9747FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.upaybr.com/pages/payment-links/reference\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pages/payment-links/reference.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.upaybr.com/#organization\",\"name\":\"Upay Gateway API\",\"url\":\"https://docs.upaybr.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/upayltda/T5HX5GY5uXX2lZeM/logo/light.png?fit=max\u0026auto=format\u0026n=T5HX5GY5uXX2lZeM\u0026q=85\u0026s=8ffdc8c1eb32a44080e0b8b936694ab2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.upaybr.com#website\",\"name\":\"Upay Gateway API\",\"url\":\"https://docs.upaybr.com\",\"publisher\":{\"@id\":\"https://docs.upaybr.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.upaybr.com/pages/payment-links/reference#webpage\",\"url\":\"https://docs.upaybr.com/pages/payment-links/reference\",\"name\":\"Referência\",\"description\":\"Documentação completa da API de Links de pagamento\",\"dateModified\":\"2026-05-26T06:28:50.806Z\",\"isPartOf\":{\"@id\":\"https://docs.upaybr.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.upaybr.com/pages/payment-links/reference#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.upaybr.com/pages/payment-links/reference#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Upay Gateway API\",\"item\":\"https://docs.upaybr.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Referência\",\"item\":\"https://docs.upaybr.com/pages/payment-links/reference\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.upaybr.com/pages/payment-links/reference#article\",\"headline\":\"Referência\",\"name\":\"Referência\",\"description\":\"Documentação completa da API de Links de pagamento\",\"url\":\"https://docs.upaybr.com/pages/payment-links/reference\",\"mainEntityOfPage\":{\"@id\":\"https://docs.upaybr.com/pages/payment-links/reference#webpage\"},\"dateModified\":\"2026-05-26T06:28:50.806Z\",\"publisher\":{\"@id\":\"https://docs.upaybr.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.upaybr.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Upay Gateway API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Upay Gateway API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/pages/payment-links/reference.md","siteName":"Upay Gateway API","nav":{"global":null,"tabs":[{"tab":"Bem-Vindo","pages":[{"title":"Bem-Vindo","href":"/pages/introduction"}]},{"tab":"Comece Aqui","pages":[{"title":"Comece Aqui","href":"/pages/quickstart"}]},{"tab":"Documentação","groups":[{"group":"Link de pagamento","pages":[{"title":"Referência","icon":"book","href":"/pages/payment-links/reference"},{"title":"Criar um novo Link de Pagamento","description":"Cria um novo link de pagamento personalizado","openapi":"POST /api/v1/payment-links","href":"/pages/payment-links/create"},{"title":"Listar Links de Pagamento","openapi":"GET /api/v1/payment-links","href":"/pages/payment-links/list"},{"title":"Obter Link de Pagamento","openapi":"GET /api/v1/payment-links/{id}","href":"/pages/payment-links/get"},{"title":"Atualizar Link de Pagamento","openapi":"PATCH /api/v1/payment-links/{id}","href":"/pages/payment-links/update"},{"title":"Deletar Link de Pagamento","openapi":"DELETE /api/v1/payment-links/{id}","href":"/pages/payment-links/delete"}]},{"group":"Produtos","pages":[{"title":"Referência","icon":"book","href":"/pages/products/reference"},{"title":"Criar um novo Produto","openapi":"POST /api/v1/products","href":"/pages/products/create"},{"title":"Listar Produtos","openapi":"GET /api/v1/products","href":"/pages/products/list"},{"title":"Obter Produto","openapi":"GET /api/v1/products/{id}","href":"/pages/products/get"},{"title":"Atualizar Produto","openapi":"PATCH /api/v1/products/{id}","href":"/pages/products/update"},{"title":"Deletar Produto","openapi":"DELETE /api/v1/products/{id}","href":"/pages/products/delete"}]},{"group":"Clientes","pages":[{"title":"Referência","icon":"book","href":"/pages/customers/reference"},{"title":"Criar um novo Cliente","openapi":"POST /api/clients","href":"/pages/customers/create"},{"title":"Listar Clientes","openapi":"GET /api/clients","href":"/pages/customers/list"},{"title":"Obter Cliente","openapi":"GET /api/clients/{id}","href":"/pages/customers/get"}]},{"group":"Cupom","pages":[{"title":"Referência","icon":"book","href":"/pages/coupon/reference"},{"title":"Criar um novo Cupom","openapi":"POST /api/v1/coupons","href":"/pages/coupon/create"},{"title":"Listar Cupons","openapi":"GET /api/v1/coupons","href":"/pages/coupon/list"},{"title":"Validar Cupom","openapi":"POST /api/coupons/validate","href":"/pages/coupon/validate"}]},{"group":"Transações","pages":[{"title":"Referência","icon":"book","href":"/pages/transactions/reference"},{"title":"Listar Transações","openapi":"GET /api/v1/transactions","href":"/pages/transactions/list"},{"title":"Criar Transação","openapi":"POST /api/v1/transactions","href":"/pages/transactions/create"},{"title":"Obter Transação","openapi":"GET /api/v1/transactions/{id}","href":"/pages/transactions/get"}]},{"group":"Saldo","pages":[{"title":"Referência","icon":"book","href":"/pages/balance/reference"},{"title":"Obter Saldo","openapi":"GET /api/v1/balance","href":"/pages/balance/get"},{"title":"Consultar Taxas","icon":"percent","href":"/pages/balance/fees"}]},{"group":"Saques","pages":[{"title":"Referência","icon":"book","href":"/pages/withdrawals/reference"},{"title":"Criar Saque","openapi":"POST /api/withdraws","href":"/pages/withdrawals/create"},{"title":"Listar Saques","openapi":"GET /api/withdraws","href":"/pages/withdrawals/list"},{"title":"Obter Saque","openapi":"GET /api/withdraws/{id}","href":"/pages/withdrawals/get"}]},{"group":"Afiliados","pages":[{"title":"Referência","icon":"book","href":"/pages/affiliates/reference"},{"title":"Listar Marketplace","openapi":"GET /api/affiliate/marketplace","href":"/pages/affiliates/marketplace"},{"title":"Solicitar Afiliação","openapi":"POST /api/affiliate/join/{programId}","href":"/pages/affiliates/join"},{"title":"Meus Links","openapi":"GET /api/affiliate/links","href":"/pages/affiliates/my-links"},{"title":"Minhas Comissões","openapi":"GET /api/affiliate/commissions","href":"/pages/affiliates/my-commissions"},{"title":"Minhas Estatísticas","openapi":"GET /api/affiliate/stats","href":"/pages/affiliates/my-stats"},{"title":"Criar Programa","openapi":"POST /api/affiliate/programs","href":"/pages/affiliates/programs-create"},{"title":"Listar Programas","openapi":"GET /api/affiliate/programs","href":"/pages/affiliates/programs-list"},{"title":"Atualizar Programa","openapi":"PATCH /api/affiliate/programs/{id}","href":"/pages/affiliates/programs-update"},{"title":"Remover Programa","openapi":"DELETE /api/affiliate/programs/{id}","href":"/pages/affiliates/programs-delete"}]},{"group":"Assinaturas","pages":[{"title":"Assinaturas Recorrentes","icon":"rotate","href":"/pages/subscriptions/reference"},{"title":"Criar plano","icon":"plus","href":"/pages/subscriptions/create-plan"},{"title":"Listar planos","icon":"list","href":"/pages/subscriptions/list-plans"},{"title":"Checkout de assinatura","icon":"cart-shopping","href":"/pages/subscriptions/checkout"},{"title":"Self-service do assinante","icon":"user","href":"/pages/subscriptions/customer"}]},{"group":"Antecipações","pages":[{"title":"Antecipações","icon":"forward","href":"/pages/advances/reference"},{"title":"Solicitar antecipação","icon":"plus","href":"/pages/advances/create"},{"title":"Listar antecipações","icon":"list","href":"/pages/advances/list"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","icon":"webhook","href":"/pages/webhooks/reference"},{"title":"Obter Informações de Webhook","openapi":"GET /api/v1/webhooks","href":"/pages/webhooks/get"},{"title":"Listar Assinaturas de Webhook","openapi":"GET /api/v1/webhooks/subscriptions","href":"/pages/webhooks/subscriptions-list"},{"title":"Criar Assinatura de Webhook","openapi":"POST /api/v1/webhooks/subscriptions","href":"/pages/webhooks/subscriptions-create"},{"title":"Atualizar Assinatura de Webhook","openapi":"PUT /api/v1/webhooks/subscriptions/{id}","href":"/pages/webhooks/subscriptions-update"},{"title":"Deletar Assinatura de Webhook","openapi":"DELETE /api/v1/webhooks/subscriptions/{id}","href":"/pages/webhooks/subscriptions-delete"},{"title":"Tipos de Eventos","icon":"bell","href":"/pages/webhooks/events"}]}]},{"tab":"Endpoints","pages":[{"title":"Endpoints","href":"/api-reference/transações/listar-transações"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/pages/sdks"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/pages/changelog"}]}]},"basePath":"","title":"Referência - Upay Gateway API","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":[],"chunks":[]}
