{
"response": null,
"errors": [
"Este serviço está temporariamente indisponível devido a manutenção"
]
}
Links de pagamento
Criar link de pagamento
Cria um link de pagamento compartilhável. Informe ao menos um produto, referenciado pelo externalId ou criado na hora (inline com name e value). Ao vincular um customer, os dados dele já vêm preenchidos automaticamente na página de checkout, agilizando o pagamento. É possível também informar um idempotency único por organização.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Alpha Gateway","description":"API de pagamentos do Alpha Gateway: PIX, boleto, links de pagamento e saques.","colors":{"primary":"#9333EA","light":"#A855F7","dark":"#7E22CE"},"logo":{"light":"https://mintcdn.com/alphagateway/2NNHxARGOgJsUVbQ/logo/light.svg?fit=max\u0026auto=format\u0026n=2NNHxARGOgJsUVbQ\u0026q=85\u0026s=a85e7ada7ab5b35e639ef4977162f105","dark":"https://mintcdn.com/alphagateway/2NNHxARGOgJsUVbQ/logo/dark.svg?fit=max\u0026auto=format\u0026n=2NNHxARGOgJsUVbQ\u0026q=85\u0026s=0592ef77aeb6995c5ca76ca703b63379"},"favicon":"https://mintcdn.com/alphagateway/2NNHxARGOgJsUVbQ/favicon.svg?fit=max\u0026auto=format\u0026n=2NNHxARGOgJsUVbQ\u0026q=85\u0026s=afcbfcf6d2ede5834f6cb1760388f1b1","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python","php"]}},"navbar":{"links":[{"href":"https://alphagateway.com.br","label":"Suporte"}],"primary":{"type":"button","label":"Acessar painel","href":"https://painel.alphagateway.com.br"}},"footer":{"socials":{"website":"https://alphagateway.com.br"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","mcp"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"pt-BR","href":"introducao"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"alphagateway","hasAudioNarration":false,"actualSubdomain":"alphagateway","customDomains":["docs.alphagateway.com.br"],"gitSource":{"type":"github","owner":"marceloko","repo":"alphagatewayservice","deployBranch":"develop","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":"","_id":"6af619c3791617e36b70d06e"},"entitlements":{},"buildId":"6af61fadfcc2e9205e891933","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"pt-BR","tag":"Referência da API","count":27},{"language":"pt-BR","tag":"Guias","count":16},{"language":"pt-BR","tag":"Webhooks - Endpoints","count":9},{"language":"pt-BR","tag":"Webhooks","count":8},{"language":"pt-BR","tag":"Cobranças - Boleto","count":5},{"language":"pt-BR","tag":"Pagamentos","count":4},{"language":"pt-BR","tag":"Conta","count":4},{"language":"pt-BR","tag":"Produtos","count":4},{"language":"pt-BR","tag":"Primeiros passos","count":3},{"language":"pt-BR","tag":"Comece aqui","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"[data-component-part=\"localization-select-trigger\"]{display:none!important}"}],"page":{"pagePath":"api-reference/cobranças--links/criar-link-de-pagamento","slug":"/api-reference/cobranças--links/criar-link-de-pagamento","pageMetadata":{"title":"Criar link de pagamento","description":"Cria um link de pagamento compartilhável. Informe ao menos um produto, referenciado pelo `externalId` ou criado na hora (inline com `name` e `value`). Ao vincular um `customer`, os dados dele já vêm preenchidos automaticamente na página de checkout, agilizando o pagamento. É possível também informar um `idempotency` único por organização.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment-links/create","href":"/api-reference/cobranças--links/criar-link-de-pagamento","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Cria um link de pagamento compartilhável. Informe ao menos um produto, referenciado pelo \", _jsx(_components.code, {\n children: \"externalId\"\n }), \" ou criado na hora (inline com \", _jsx(_components.code, {\n children: \"name\"\n }), \" e \", _jsx(_components.code, {\n children: \"value\"\n }), \"). Ao vincular um \", _jsx(_components.code, {\n children: \"customer\"\n }), \", os dados dele já vêm preenchidos automaticamente na página de checkout, agilizando o pagamento. É possível também informar um \", _jsx(_components.code, {\n children: \"idempotency\"\n }), \" único por organização.\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Criar link de pagamento","description":"Cria um link de pagamento compartilhável. Informe ao menos um produto, referenciado pelo `externalId` ou criado na hora (inline com `name` e `value`). Ao vincular um `customer`, os dados dele já vêm preenchidos automaticamente na página de checkout, agilizando o pagamento. É possível também informar um `idempotency` único por organização.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment-links/create","href":"/api-reference/cobranças--links/criar-link-de-pagamento","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createPaymentLink","summary":"Criar link de pagamento","tags":["Cobranças - Links"],"description":"Cria um link de pagamento compartilhável. Informe ao menos um produto, referenciado pelo `externalId` ou criado na hora (inline com `name` e `value`). Ao vincular um `customer`, os dados dele já vêm preenchidos automaticamente na página de checkout, agilizando o pagamento. É possível também informar um `idempotency` único por organização.","requestBody":"bd2f5aea-0826-423f-b259-50339e9133f4","security":["d23b7041-25f5-41c7-a04c-142e1d8342bf"],"x-public-api":true,"responses":{"200":"62ba30ce-634d-43dc-a265-213c8cef62f5","400":"458a37d8-5ecb-4586-892f-061d2edb1c3a","401":"0f46b3fd-cc63-4856-8f52-ecb0d1c0f3cf","403":"d80d9415-77ff-43ae-86fc-3c863112c35d","404":"9795c2b0-1e17-442a-be4b-d3395befa811","409":"d1571932-2f69-4543-a8b6-ed7508d6d228","429":"dd3ab98f-8b44-47a0-adc9-d88ae08769b9","500":"5f433aca-f46c-4abc-8d2d-533ad298acd5","503":"d0067c2d-0541-4105-9a8d-0585143a5844"},"method":"post","type":"path","servers":["e2908a89-04f8-42ff-be7b-4c7b62022cc1"],"path":"/v1/payment-links/create","baseUrlOptions":["https://api.alphagateway.com.br"],"title":"Criar link de pagamento","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","php"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"products":{"type":"array","items":{"oneOf":[{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"ID externo de um produto já cadastrado no catálogo da organização.","isRequired":true,"uniqueKey":"products.items.[INDEX].oneOf.0.externalId","typeLabel":"string"},"quantity":{"type":"integer","minimum":1,"description":"Quantidade desse produto no link. Padrão: 1.","uniqueKey":"products.items.[INDEX].oneOf.0.quantity","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"products.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","maxLength":100,"description":"Nome do produto criado na hora (inline), sem precisar cadastrar antes.","isRequired":true,"uniqueKey":"products.items.[INDEX].oneOf.1.name","typeLabel":"string"},"value":{"type":"number","exclusiveMinimum":true,"minimum":0,"description":"Valor unitário do produto inline, em reais (ex.: 49.90).","isRequired":true,"uniqueKey":"products.items.[INDEX].oneOf.1.value","typeLabel":"number"},"description":{"type":"string","maxLength":500,"description":"Descrição opcional do produto inline.","uniqueKey":"products.items.[INDEX].oneOf.1.description","typeLabel":"string"},"quantity":{"type":"integer","minimum":1,"description":"Quantidade desse produto no link. Padrão: 1.","uniqueKey":"products.items.[INDEX].oneOf.1.quantity","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"products.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"products.items.[INDEX]","typeLabel":"object"},"minItems":1,"description":"Lista de produtos do link (mínimo 1). Cada item pode ser um produto existente (via `externalId`) ou um produto inline (via `name` e `value`).","isRequired":true,"uniqueKey":"products","typeLabel":"object[]"},"paymentMethods":{"type":"array","items":{"type":"string","enum":["PIX_IN","CARD","BOLETO"],"uniqueKey":"paymentMethods.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"description":"Métodos de pagamento aceitos pelo link (mínimo 1).","isRequired":true,"uniqueKey":"paymentMethods","typeLabel":"enum\u003cstring>[]"},"customer":{"type":"object","properties":{"fullName":{"type":"string","minLength":1,"description":"Nome completo (nome e sobrenome).","isRequired":true,"uniqueKey":"customer.fullName","typeLabel":"string"},"document":{"type":"string","description":"CPF (11 dígitos) ou CNPJ (14 dígitos), só números e válido.","isRequired":true,"uniqueKey":"customer.document","typeLabel":"string"},"email":{"type":"string","format":"email","description":"E-mail (opcional).","uniqueKey":"customer.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","minLength":10,"maxLength":11,"pattern":"^\\d+$","description":"Telefone com DDD, só números, 10 ou 11 dígitos (opcional).","uniqueKey":"customer.phone","typeLabel":"string"}},"required":["fullName","document"],"additionalProperties":false,"description":"Cliente vinculado ao link (opcional). Quando informado (`fullName` e `document`), os dados já vêm preenchidos na página de checkout.","uniqueKey":"customer","typeLabel":"object"},"idempotency":{"type":"string","minLength":1,"description":"Identificador único por organização. Evita criar o mesmo link duas vezes; uma segunda chamada com o mesmo valor retorna erro 409.","uniqueKey":"idempotency","typeLabel":"string"},"callbackOnSuccess":{"type":"string","format":"uri","description":"URL para redirecionar o pagador após o pagamento ser confirmado.","uniqueKey":"callbackOnSuccess","typeLabel":"string\u003curi>"},"callbackOnError":{"type":"string","format":"uri","description":"URL para redirecionar o pagador em caso de erro ou cancelamento.","uniqueKey":"callbackOnError","typeLabel":"string\u003curi>"},"paymentLimit":{"type":"integer","minimum":0,"description":"Número máximo de pagamentos aceitos pelo link. Use 0 ou omita para não limitar (ilimitado).","uniqueKey":"paymentLimit","typeLabel":"integer"},"recurrent":{"type":"boolean","description":"Habilita a recorrência: o pagamento com cartão salva o token do cartão para cobranças automáticas futuras. Exige CARD em paymentMethods.","uniqueKey":"recurrent","typeLabel":"boolean"}},"required":["products","paymentMethods"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"products":[{"externalId":"plano-mensal","quantity":1},{"name":"Taxa de adesão","value":19.9}],"paymentMethods":["PIX_IN","BOLETO"],"customer":{"fullName":"Maria Oliveira Santos","document":"12345678909","email":"maria@exemplo.com.br","phone":"65999998888"},"idempotency":"link-4001","callbackOnSuccess":"https://loja.exemplo.com.br/obrigado","paymentLimit":1},"examples":{"Example":{"title":"Example","value":{"products":[{"externalId":"plano-mensal","quantity":1},{"name":"Taxa de adesão","value":19.9}],"paymentMethods":["PIX_IN","BOLETO"],"customer":{"fullName":"Maria Oliveira Santos","document":"12345678909","email":"maria@exemplo.com.br","phone":"65999998888"},"idempotency":"link-4001","callbackOnSuccess":"https://loja.exemplo.com.br/obrigado","paymentLimit":1}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"62ba30ce-634d-43dc-a265-213c8cef62f5":{"description":"Requisição processada com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"id":{"type":"string","description":"ID interno do link de pagamento.","isRequired":true,"uniqueKey":"response.id","typeLabel":"string"},"token":{"type":"string","description":"Token público do link, usado na URL de checkout.","isRequired":true,"uniqueKey":"response.token","typeLabel":"string"},"status":{"type":"string","description":"Status do link (ex.: ACTIVE).","isRequired":true,"uniqueKey":"response.status","typeLabel":"string"},"idempotency":{"oneOf":[{"type":"string","description":"Identificador único informado na criação, ou null se não informado.","isRequired":true,"uniqueKey":"response.idempotency.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identificador único informado na criação, ou null se não informado.","isRequired":true,"uniqueKey":"response.idempotency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"response.idempotency","typeLabel":"string | null"},"paymentMethods":{"type":"array","items":{"type":"string","uniqueKey":"response.paymentMethods.items.[INDEX]","typeLabel":"string"},"description":"Métodos de pagamento habilitados no link.","isRequired":true,"uniqueKey":"response.paymentMethods","typeLabel":"string[]"},"recurrent":{"type":"boolean","description":"Indica se o link é recorrente (salva o token do cartão para cobranças futuras).","isRequired":true,"uniqueKey":"response.recurrent","typeLabel":"boolean"},"url":{"type":"string","description":"URL pública de checkout para compartilhar com o cliente.","isRequired":true,"uniqueKey":"response.url","typeLabel":"string"}},"required":["id","token","status","idempotency","paymentMethods","recurrent","url"],"additionalProperties":false,"description":"Dados retornados pela operação; null quando não há conteúdo.","isRequired":true,"uniqueKey":"response","typeLabel":"object"},"message":{"type":"string","description":"Mensagem que descreve o resultado.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["response","message"],"additionalProperties":false,"description":"Requisição processada com sucesso","uniqueKey":"","typeLabel":"object"},"example":{"message":"Link de pagamento criado com sucesso","response":{"id":"01961234-abcd-7000-8000-000000000004","token":"k7Qm2xPz","status":"ACTIVE","idempotency":"link-4001","paymentMethods":["PIX_IN","BOLETO"],"recurrent":false,"url":"https://painel.alphagateway.com.br/payment/checkout/k7Qm2xPz"}},"examples":{"Example":{"title":"Example","value":{"message":"Link de pagamento criado com sucesso","response":{"id":"01961234-abcd-7000-8000-000000000004","token":"k7Qm2xPz","status":"ACTIVE","idempotency":"link-4001","paymentMethods":["PIX_IN","BOLETO"],"recurrent":false,"url":"https://painel.alphagateway.com.br/payment/checkout/k7Qm2xPz"}}}},"exampleType":"examples"}},"exampleType":"examples"},"458a37d8-5ecb-4586-892f-061d2edb1c3a":{"description":"Requisição inválida: campo ausente ou fora do formato, regra de negócio recusada, funcionalidade não habilitada para a organização ou `idempotency` já usado. Se `errors` disser que o `idempotency` já existe, a operação JÁ FOI CRIADA: consulte-a pelo mesmo `idempotency` e não gere outro. Nos demais casos, corrija conforme `errors` antes de tentar de novo.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"oneOf":[{"default":null,"description":"Sempre null em respostas de erro.","uniqueKey":"response.oneOf.0","typeLabel":"any"},{"default":null,"description":"Sempre null em respostas de erro.","type":"null","uniqueKey":"response.oneOf.1","typeLabel":"null"}],"uniqueKey":"response","typeLabel":"any | null"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Mensagens que explicam o erro.","uniqueKey":"errors","typeLabel":"string[]"}},"additionalProperties":false,"description":"Ocorreu um erro ao processar a requisição","uniqueKey":"","typeLabel":"object"},"example":{"response":null,"errors":["O valor da transação deve ser maior ou igual a R$1,00"]},"examples":{"Example":{"title":"Example","value":{"response":null,"errors":["O valor da transação deve ser maior ou igual a R$1,00"]}}},"exampleType":"examples"}},"exampleType":"examples"},"0f46b3fd-cc63-4856-8f52-ecb0d1c0f3cf":{"description":"API Key ausente, inválida ou expirada no header `x-api-key`.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"oneOf":[{"default":null,"description":"Sempre null em respostas de erro.","uniqueKey":"response.oneOf.0","typeLabel":"any"},{"default":null,"description":"Sempre null em respostas de erro.","type":"null","uniqueKey":"response.oneOf.1","typeLabel":"null"}],"uniqueKey":"response","typeLabel":"any | null"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Mensagens que explicam o erro.","uniqueKey":"errors","typeLabel":"string[]"}},"additionalProperties":false,"description":"Ocorreu um erro ao processar a requisição","uniqueKey":"","typeLabel":"object"},"example":{"response":null,"errors":["API key inválida ou expirada"]},"examples":{"Example":{"title":"Example","value":{"response":null,"errors":["API key inválida ou expirada"]}}},"exampleType":"examples"}},"exampleType":"examples"},"d80d9415-77ff-43ae-86fc-3c863112c35d":{"description":"A API Key não tem o escopo desta funcionalidade, a origem (domínio ou IP) não está autorizada para a chave ou a organização está bloqueada.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"oneOf":[{"default":null,"description":"Sempre null em respostas de erro.","uniqueKey":"response.oneOf.0","typeLabel":"any"},{"default":null,"description":"Sempre null em respostas de erro.","type":"null","uniqueKey":"response.oneOf.1","typeLabel":"null"}],"uniqueKey":"response","typeLabel":"any | null"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Mensagens que explicam o erro.","uniqueKey":"errors","typeLabel":"string[]"}},"additionalProperties":false,"description":"Ocorreu um erro ao processar a requisição","uniqueKey":"","typeLabel":"object"},"example":{"response":null,"errors":["Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."]},"examples":{"Example":{"title":"Example","value":{"response":null,"errors":["Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."]}}},"exampleType":"examples"}},"exampleType":"examples"},"9795c2b0-1e17-442a-be4b-d3395befa811":{"description":"Recurso não encontrado para a organização da API Key (confira o identificador informado).","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"oneOf":[{"default":null,"description":"Sempre null em respostas de erro.","uniqueKey":"response.oneOf.0","typeLabel":"any"},{"default":null,"description":"Sempre null em respostas de erro.","type":"null","uniqueKey":"response.oneOf.1","typeLabel":"null"}],"uniqueKey":"response","typeLabel":"any | null"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Mensagens que explicam o erro.","uniqueKey":"errors","typeLabel":"string[]"}},"additionalProperties":false,"description":"Ocorreu um erro ao processar a requisição","uniqueKey":"","typeLabel":"object"},"example":{"response":null,"errors":["Transação não encontrada"]},"examples":{"Example":{"title":"Example","value":{"response":null,"errors":["Transação não encontrada"]}}},"exampleType":"examples"}},"exampleType":"examples"},"d1571932-2f69-4543-a8b6-ed7508d6d228":{"description":"Conflito: o identificador informado (`idempotency` ou `externalId`) já está em uso na organização.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"oneOf":[{"default":null,"description":"Sempre null em respostas de erro.","uniqueKey":"response.oneOf.0","typeLabel":"any"},{"default":null,"description":"Sempre null em respostas de erro.","type":"null","uniqueKey":"response.oneOf.1","typeLabel":"null"}],"uniqueKey":"response","typeLabel":"any | null"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Mensagens que explicam o erro.","uniqueKey":"errors","typeLabel":"string[]"}},"additionalProperties":false,"description":"Ocorreu um erro ao processar a requisição","uniqueKey":"","typeLabel":"object"},"example":{"response":null,"errors":["Já existe um link de pagamento com este idempotency"]},"examples":{"Example":{"title":"Example","value":{"response":null,"errors":["Já existe um link de pagamento com este idempotency"]}}},"exampleType":"examples"}},"exampleType":"examples"},"dd3ab98f-8b44-47a0-adc9-d88ae08769b9":{"description":"Limite de requisições da API Key excedido. Aguarde alguns segundos e tente de novo.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"oneOf":[{"default":null,"description":"Sempre null em respostas de erro.","uniqueKey":"response.oneOf.0","typeLabel":"any"},{"default":null,"description":"Sempre null em respostas de erro.","type":"null","uniqueKey":"response.oneOf.1","typeLabel":"null"}],"uniqueKey":"response","typeLabel":"any | null"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Mensagens que explicam o erro.","uniqueKey":"errors","typeLabel":"string[]"}},"additionalProperties":false,"description":"Ocorreu um erro ao processar a requisição","uniqueKey":"","typeLabel":"object"},"example":{"response":null,"errors":["Limite de requisições excedido"]},"examples":{"Example":{"title":"Example","value":{"response":null,"errors":["Limite de requisições excedido"]}}},"exampleType":"examples"}},"exampleType":"examples"},"5f433aca-f46c-4abc-8d2d-533ad298acd5":{"description":"Erro inesperado. Antes de repetir uma criação, consulte a operação pelo mesmo `idempotency`: se ela já existir, não crie outra.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"oneOf":[{"default":null,"description":"Sempre null em respostas de erro.","uniqueKey":"response.oneOf.0","typeLabel":"any"},{"default":null,"description":"Sempre null em respostas de erro.","type":"null","uniqueKey":"response.oneOf.1","typeLabel":"null"}],"uniqueKey":"response","typeLabel":"any | null"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Mensagens que explicam o erro.","uniqueKey":"errors","typeLabel":"string[]"}},"additionalProperties":false,"description":"Ocorreu um erro ao processar a requisição","uniqueKey":"","typeLabel":"object"},"example":{"response":null,"errors":["Erro interno"]},"examples":{"Example":{"title":"Example","value":{"response":null,"errors":["Erro interno"]}}},"exampleType":"examples"}},"exampleType":"examples"},"d0067c2d-0541-4105-9a8d-0585143a5844":{"description":"Serviço em manutenção programada. Tente de novo mais tarde.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"oneOf":[{"default":null,"description":"Sempre null em respostas de erro.","uniqueKey":"response.oneOf.0","typeLabel":"any"},{"default":null,"description":"Sempre null em respostas de erro.","type":"null","uniqueKey":"response.oneOf.1","typeLabel":"null"}],"uniqueKey":"response","typeLabel":"any | null"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Mensagens que explicam o erro.","uniqueKey":"errors","typeLabel":"string[]"}},"additionalProperties":false,"description":"Ocorreu um erro ao processar a requisição","uniqueKey":"","typeLabel":"object"},"example":{"response":null,"errors":["Este serviço está temporariamente indisponível devido a manutenção"]},"examples":{"Example":{"title":"Example","value":{"response":null,"errors":["Este serviço está temporariamente indisponível devido a manutenção"]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"d23b7041-25f5-41c7-a04c-142e1d8342bf":{"x-api-key":{"type":"apiKey","in":"header","name":"x-api-key","description":"API Key da organização","scopes":[],"schemeName":"x-api-key"}}},"servers":{"e2908a89-04f8-42ff-be7b-4c7b62022cc1":{"url":"https://api.alphagateway.com.br","description":"Servidor da API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API Key da organização","scopes":[],"schemeName":"x-api-key"},"schema":{"title":"x-api-key","type":"string","description":"API Key da organização","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"x-api-key","name":"x-api-key"}],"title":"x-api-key"}]},"originalFileLocation":"openapi.json"},"subdomain":"alphagateway","siteName":"Alpha Gateway","title":"Criar link de pagamento - Alpha Gateway","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/api-reference/cobranças--links/criar-link-de-pagamento","matchLevel":0}}},"lastModified":"2026-11-12T20:13:04.506Z","originalFileLocation":"api-reference/cobranças--links/criar-link-de-pagamento.mdx","locale":"pt-BR"},"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=\"Cria um link de pagamento compartilhável. Informe ao menos um produto, referenciado pelo externalId ou criado na hora (inline com name e value). Ao vincular um customer, os dados dele já vêm preenchidos automaticamente na página de checkout, agilizando o pagamento. É possível também informar um idempotency único por organização.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Alpha Gateway\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/alphagateway/7YB6Q7Q4hLTDfSgW/_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/alphagateway/7YB6Q7Q4hLTDfSgW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/alphagateway/7YB6Q7Q4hLTDfSgW/_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/alphagateway/7YB6Q7Q4hLTDfSgW/_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/alphagateway/7YB6Q7Q4hLTDfSgW/_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/alphagateway/7YB6Q7Q4hLTDfSgW/_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/alphagateway/7YB6Q7Q4hLTDfSgW/_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/alphagateway/7YB6Q7Q4hLTDfSgW/_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/alphagateway/7YB6Q7Q4hLTDfSgW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Criar link de pagamento - Alpha Gateway\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cria um link de pagamento compartilhável. Informe ao menos um produto, referenciado pelo externalId ou criado na hora (inline com name e value). Ao vincular um customer, os dados dele já vêm preenchidos automaticamente na página de checkout, agilizando o pagamento. É possível também informar um idempotency único por organização.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Alpha Gateway\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.alphagateway.com.br/api-reference/cobranças--links/criar-link-de-pagamento\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://alphagateway.mintlify.site/_mintlify/api/og/v2?division=Links+de+pagamento\u0026amp;title=Criar+link+de+pagamento\u0026amp;description=Cria+um+link+de+pagamento+compartilh%C3%A1vel.+Informe+ao+menos+um+produto%2C+referenciado+pelo+%60externalId%60+ou+criado+na+hora+%28inline+com+%60name%60+e+%60value%60%29.+Ao+vincul\u0026amp;theme=dfb378136de2a89defb5f806\u0026amp;signature=d133074cd601d824b5b98c92985d1531b6c2acb23186f4f15018a830447597d1\">\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=\"Criar link de pagamento - Alpha Gateway\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cria um link de pagamento compartilhável. Informe ao menos um produto, referenciado pelo externalId ou criado na hora (inline com name e value). Ao vincular um customer, os dados dele já vêm preenchidos automaticamente na página de checkout, agilizando o pagamento. É possível também informar um idempotency único por organização.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://alphagateway.mintlify.site/_mintlify/api/og/v2?division=Links+de+pagamento\u0026amp;title=Criar+link+de+pagamento\u0026amp;description=Cria+um+link+de+pagamento+compartilh%C3%A1vel.+Informe+ao+menos+um+produto%2C+referenciado+pelo+%60externalId%60+ou+criado+na+hora+%28inline+com+%60name%60+e+%60value%60%29.+Ao+vincul\u0026amp;theme=dfb378136de2a89defb5f806\u0026amp;signature=d133074cd601d824b5b98c92985d1531b6c2acb23186f4f15018a830447597d1\">\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/alphagateway/7YB6Q7Q4hLTDfSgW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Alpha Gateway\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9333EA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.alphagateway.com.br/api-reference/cobranças--links/criar-link-de-pagamento\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/cobran%C3%A7as--links/criar-link-de-pagamento.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.alphagateway.com.br/#organization\",\"name\":\"Alpha Gateway\",\"url\":\"https://docs.alphagateway.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/alphagateway/2NNHxARGOgJsUVbQ/logo/light.svg?fit=max\u0026auto=format\u0026n=2NNHxARGOgJsUVbQ\u0026q=85\u0026s=a85e7ada7ab5b35e639ef4977162f105\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.alphagateway.com.br#website\",\"name\":\"Alpha Gateway\",\"url\":\"https://docs.alphagateway.com.br\",\"publisher\":{\"@id\":\"https://docs.alphagateway.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.alphagateway.com.br/api-reference/cobran%C3%A7as--links/criar-link-de-pagamento#webpage\",\"url\":\"https://docs.alphagateway.com.br/api-reference/cobran%C3%A7as--links/criar-link-de-pagamento\",\"name\":\"Criar link de pagamento\",\"description\":\"Cria um link de pagamento compartilhável. Informe ao menos um produto, referenciado pelo externalId ou criado na hora (inline com name e value). Ao vincular um customer, os dados dele já vêm preenchidos automaticamente na página de checkout, agilizando o pagamento. É possível também informar um idempotency único por organização.\",\"dateModified\":\"2026-11-12T20:13:04.506Z\",\"isPartOf\":{\"@id\":\"https://docs.alphagateway.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.alphagateway.com.br/api-reference/cobran%C3%A7as--links/criar-link-de-pagamento#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.alphagateway.com.br/api-reference/cobran%C3%A7as--links/criar-link-de-pagamento#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.alphagateway.com.br/api-reference/cobran%C3%A7as--pix/gerar-qr-code-pix\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Criar link de pagamento\",\"item\":\"https://docs.alphagateway.com.br/api-reference/cobran%C3%A7as--links/criar-link-de-pagamento\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.alphagateway.com.br/api-reference/cobran%C3%A7as--links/criar-link-de-pagamento#apireference\",\"headline\":\"Criar link de pagamento\",\"name\":\"Criar link de pagamento\",\"description\":\"Cria um link de pagamento compartilhável. Informe ao menos um produto, referenciado pelo externalId ou criado na hora (inline com name e value). Ao vincular um customer, os dados dele já vêm preenchidos automaticamente na página de checkout, agilizando o pagamento. É possível também informar um idempotency único por organização.\",\"url\":\"https://docs.alphagateway.com.br/api-reference/cobran%C3%A7as--links/criar-link-de-pagamento\",\"mainEntityOfPage\":{\"@id\":\"https://docs.alphagateway.com.br/api-reference/cobran%C3%A7as--links/criar-link-de-pagamento#webpage\"},\"dateModified\":\"2026-11-12T20:13:04.506Z\",\"publisher\":{\"@id\":\"https://docs.alphagateway.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.alphagateway.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Alpha Gateway\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Alpha Gateway\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/cobran%C3%A7as--links/criar-link-de-pagamento.md","siteName":"Alpha Gateway","nav":{"global":null,"languages":[{"language":"pt-BR","tabs":[{"tab":"Primeiros passos","pages":[{"title":"Primeiros passos","href":"/introducao"}]},{"tab":"Guias","pages":[{"title":"Guias","href":"/guias/cobrancas-pix"}]},{"tab":"Referência da API","groups":[{"group":"Endpoints","pages":[{"group":"Cobranças PIX","pages":[{"title":"Gerar QR Code PIX","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/pix-in/create","href":"/api-reference/cobranças--pix/gerar-qr-code-pix"},{"title":"Consultar cobrança","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/pix-in/query/{idempotency}","href":"/api-reference/cobranças--pix/consultar-cobrança"},{"title":"Efetivar pagamento (Ambiente de teste)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/pix-in/pay-homologation","href":"/api-reference/cobranças--pix/efetivar-pagamento-ambiente-de-teste"}]},{"group":"Boletos","pages":[{"title":"Criar boleto","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/boleto/create","href":"/api-reference/cobranças--boleto/criar-boleto"},{"title":"Consultar boleto","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/boleto/query/{idempotency}","href":"/api-reference/cobranças--boleto/consultar-boleto"},{"title":"Cancelar boleto","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/boleto/cancel","href":"/api-reference/cobranças--boleto/cancelar-boleto"},{"title":"Segunda via do boleto (PDF)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/boleto/pdf/{idempotency}","href":"/api-reference/cobranças--boleto/segunda-via-do-boleto-pdf"},{"title":"Efetivar pagamento de boleto (Ambiente de teste)","description":"Efetiva o pagamento de um boleto manualmente para testes. Disponível apenas no ambiente de homologação.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/boleto/pay-homologation","href":"/api-reference/cobranças--boleto/efetivar-pagamento-de-boleto-ambiente-de-teste"}]},{"group":"Links de pagamento","pages":[{"title":"Criar link de pagamento","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment-links/create","href":"/api-reference/cobranças--links/criar-link-de-pagamento"},{"title":"Consultar link de pagamento","description":"Retorna os detalhes de um link de pagamento, incluindo status, produtos vinculados e contagem de pagamentos realizados.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment-links/query/{id}","href":"/api-reference/cobranças--links/consultar-link-de-pagamento"}]},{"group":"Saques","pages":[{"title":"Solicitar saque","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/pix-out/create","href":"/api-reference/saques/solicitar-saque"},{"title":"Consultar saque","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/pix-out/query/{idempotency}","href":"/api-reference/saques/consultar-saque"}]},{"group":"Conta e saldo","pages":[{"title":"Consultar contexto da conta","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/account/context","href":"/api-reference/conta/consultar-contexto-da-conta"},{"title":"Consultar saldo","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/wallet/balance/organization","href":"/api-reference/conta/consultar-saldo"}]},{"group":"Produtos","pages":[{"title":"Criar produto","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/products/create","href":"/api-reference/produtos/criar-produto"},{"title":"Listar produtos","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/products/list","href":"/api-reference/produtos/listar-produtos"},{"title":"Consultar produto","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/products/query/{externalId}","href":"/api-reference/produtos/consultar-produto"},{"title":"Atualizar produto","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/products/update/{externalId}","href":"/api-reference/produtos/atualizar-produto"}]},{"group":"Webhooks","pages":[{"title":"Listar eventos de webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhook-event-types","href":"/api-reference/webhooks--endpoints/listar-eventos-de-webhook"},{"title":"Listar endpoints de webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhook-endpoints","href":"/api-reference/webhooks--endpoints/listar-endpoints-de-webhook"},{"title":"Criar endpoint de webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhook-endpoints","href":"/api-reference/webhooks--endpoints/criar-endpoint-de-webhook"},{"title":"Consultar endpoint de webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhook-endpoints/{id}","href":"/api-reference/webhooks--endpoints/consultar-endpoint-de-webhook"},{"title":"Atualizar endpoint de webhook","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/webhook-endpoints/{id}","href":"/api-reference/webhooks--endpoints/atualizar-endpoint-de-webhook"},{"title":"Remover endpoint de webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/webhook-endpoints/{id}","href":"/api-reference/webhooks--endpoints/remover-endpoint-de-webhook"},{"title":"Rotacionar credencial do webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhook-endpoints/{id}/secret/rotate","href":"/api-reference/webhooks--endpoints/rotacionar-credencial-do-webhook"},{"title":"Listar entregas de webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhook-deliveries","href":"/api-reference/webhooks--endpoints/listar-entregas-de-webhook"},{"title":"Reenviar entrega de webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhook-deliveries/{id}/resend","href":"/api-reference/webhooks--endpoints/reenviar-entrega-de-webhook"}]}]}]}]}]},"basePath":"","title":"Criar link de pagamento - Alpha Gateway","buildId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","deploymentId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DDP9JXtj.js","utils-8yQyvEtx.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CBCFR8Sn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-rQaXkUHa.js","snippetPresets-J5KpBTgV.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BVxVH4Cj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BxdQ2vIi.js","shallow-BjV2tFiD.js","getApiPlaygroundDisplay-C_55tL4O.js","CodeSnippet-C0JpiCOC.js","CodeSnippets-w9Ps7djG.js","Page-DTNSD-0M.js","getPastedJson-BDfB-H8d.js","icon-g-kUkkO9.js","MethodPill-v4l6fq0h.js","DuplicateIcon-CvLo-CfU.js","createIcon-165clrrV.js","DynamicMarkdown-D3RQ-fEj.js","SectionHeading-vvo-3yLf.js","axios-vUo_bRtp.js","Markdown-CMT1uFWQ.js","clsx-C8f2yC9R.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CI2D8R2Y.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-k78Wrw_e.js"]}