Aprenda como integrar perfeitamente nossas APIs em sua aplicação.
Antes de começar!
Você deve criar uma conta gratuita do Yiksi Pay para testar a API. Forneceremos chaves de teste que você pode usar para fazer chamadas à API.
A API do Yiksi Pay oferece acesso a praticamente todos os recursos que você pode usar em nosso painel e permite estendê-los para uso em sua aplicação. Ela se esforça para ser RESTful e está organizada em torno dos principais recursos com os quais você estaria interagindo - com algumas exceções notáveis.
Fornecemos chamadas de API de exemplo ao lado de cada método usando cURL. Tudo o que você precisa fazer é inserir seus parâmetros específicos e testar as chamadas pela linha de comando. Veja este tutorial sobre usando cURL com APIs.Você também pode usar o Postman se não estiver familiarizado com o cURL. O Postman é uma plataforma fácil de usar para desenvolvimento e teste de APIs. Você pode explorar a Coleção do Postman do Yiksi Pay para entender como nossas APIs funcionam.
Tanto os dados do corpo da requisição quanto os dados da resposta são formatados como JSON. O tipo de conteúdo para respostas será sempre application/json. Geralmente, todas as respostas estarão no seguinte formato:
Este é o código de status da requisição que permite saber se sua requisição foi bem-sucedida ou não. Recomendamos que você use isso para determinar o resultado de uma chamada de API.
message
string
Este é um resumo da resposta e seu status. Por exemplo, ao tentar recuperar uma lista de clientes, a mensagem pode dizer “Transações obtidas com sucesso”. No caso de um erro, a chave message conterá uma descrição do erro, como na situação do cabeçalho de autorização acima. Esta é a única chave que é universal em todas as requisições.
data
object
Contém os resultados da sua requisição. Pode ser um objeto ou um array, dependendo da requisição feita. Por exemplo, uma requisição para recuperar uma única transação retornará um objeto de transação na chave data, enquanto a chave seria um array de transações se uma lista for solicitada.
A chave meta é usada para fornecer contexto para o conteúdo da chave data. Por exemplo, se uma lista de transações realizadas por um cliente estiver sendo recuperada, parâmetros de paginação podem ser passados para limitar o conjunto de resultados. A chave meta conterá então um objeto com os seguintes atributos:
O número total de itens disponíveis. Representa a contagem completa de itens em todas as páginas.
itemCount
O número de itens na página atual. Indica quantos itens estão sendo retornados na resposta atual.
itemsPerPage
O número máximo de itens por página. Define o limite de paginação definido para cada página. Padrão: 100
totalPages
O número total de páginas disponíveis. É calculado com base no número total de itens e no número de itens por página.
currentPage
O número da página atual. Indica qual página da paginação está sendo retornada na resposta atual. Padrão: 1
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Yiksi Pay","colors":{"primary":"#6B53E2","light":"#8E72FF","dark":"#6B53E2"},"logo":{"light":"https://mintcdn.com/yiksipay/4IZNODSIyaoI_2s_/logo/light.png?fit=max\u0026auto=format\u0026n=4IZNODSIyaoI_2s_\u0026q=85\u0026s=6d5bc3bce8ca8b192d20804f89f45456","dark":"https://mintcdn.com/yiksipay/4IZNODSIyaoI_2s_/logo/dark.png?fit=max\u0026auto=format\u0026n=4IZNODSIyaoI_2s_\u0026q=85\u0026s=d798a6444634f2d08eaf267d185b968d"},"favicon":"https://mintcdn.com/yiksipay/pFjIfRqPiQ-3l9Ci/favicon.svg?fit=max\u0026auto=format\u0026n=pFjIfRqPiQ-3l9Ci\u0026q=85\u0026s=97e1387680dbf2d0939e2bde69dbad31","navbar":{"links":[{"href":"mailto:partner@yiksi.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.yiksipay.com"}},"footer":{"socials":{"x":"https://x.com/yiksiexchange","linkedin":"https://www.linkedin.com/company/yiksiexchange"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","href":"en/introduction"},{"language":"es","href":"es/introduction"},{"language":"pt","href":"pt/introduction"},{"language":"fr","href":"fr/introduction"},{"language":"zh","href":"zh/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"yiksipay","hasAudioNarration":false,"actualSubdomain":"yiksipay","customDomains":["docs.yiksipay.com"],"gitSource":{"type":"github","owner":"yiksi-inc","repo":"yiksi-pay-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21db7470c69447c725ea25","collectionId":"42fe3f44-e4ae-49a7-8559-93f3414bffca","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21db7470c69447c725ea25:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"en","tag":"API Reference","count":76},{"language":"es","tag":"Referencia API","count":76},{"language":"fr","tag":"Référence API","count":76},{"language":"pt","tag":"Referência da API","count":76},{"language":"zh","tag":"API 参考","count":76},{"language":"en","tag":"Auto Settlements","count":14},{"language":"es","tag":"Liquidaciones Automáticas","count":14},{"language":"fr","tag":"Règlements Automatiques","count":14},{"language":"pt","tag":"Liquidações Automáticas","count":14},{"language":"zh","tag":"自动结算","count":14},{"language":"en","tag":"Security","count":12},{"language":"es","tag":"Seguridad","count":12},{"language":"fr","tag":"Sécurité","count":12},{"language":"pt","tag":"Segurança","count":12},{"language":"zh","tag":"安全","count":12},{"language":"en","tag":"Address","count":10},{"language":"en","tag":"Documentation","count":10},{"language":"es","tag":"Dirección","count":10},{"language":"es","tag":"Documentación","count":10},{"language":"fr","tag":"Adresse","count":10},{"language":"fr","tag":"Documentation","count":10},{"language":"pt","tag":"Endereço","count":10},{"language":"pt","tag":"Documentação","count":10},{"language":"zh","tag":"地址","count":10},{"language":"zh","tag":"文档","count":10},{"language":"en","tag":"Essentials","count":9},{"language":"es","tag":"Esenciales","count":9},{"language":"fr","tag":"Essentiels","count":9},{"language":"pt","tag":"Essenciais","count":9},{"language":"zh","tag":"核心功能","count":9},{"language":"en","tag":"Smart Contract","count":8},{"language":"es","tag":"Contratos Inteligentes","count":8},{"language":"fr","tag":"Contrats Intelligents","count":8},{"language":"pt","tag":"Contratos Inteligentes","count":8},{"language":"zh","tag":"智能合约","count":8},{"language":"en","tag":"Transactions","count":7},{"language":"en","tag":"Master Wallet","count":7},{"language":"es","tag":"Transacciones","count":7},{"language":"es","tag":"Billetera Principal","count":7},{"language":"fr","tag":"Transactions","count":7},{"language":"fr","tag":"Portefeuille Principal","count":7},{"language":"pt","tag":"Transações","count":7},{"language":"pt","tag":"Carteira Principal","count":7},{"language":"zh","tag":"交易","count":7},{"language":"zh","tag":"主钱包","count":7},{"language":"en","tag":"Withdraw","count":6},{"language":"es","tag":"Retiro","count":6},{"language":"fr","tag":"Retrait","count":6},{"language":"pt","tag":"Saque","count":6},{"language":"zh","tag":"提款","count":6}]},"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":"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"pt/api-reference/introduction","slug":"/pt/api-reference/introduction","pageMetadata":{"title":"Introdução","description":"Aprenda como integrar perfeitamente nossas APIs em sua aplicação.","icon":"circle","href":"/pt/api-reference/introduction"},"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: \"Aprenda como integrar perfeitamente nossas APIs em sua aplicaçã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,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}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsxs(_components.p,{children:[`Antes de começar!`,_jsx(`br`,{}),`\nVocê deve criar uma conta gratuita do Yiksi Pay para testar a API. Forneceremos chaves de teste que você pode usar para fazer chamadas à API.`]})}),`\n`,_jsx(_components.p,{children:`A API do Yiksi Pay oferece acesso a praticamente todos os recursos que você pode usar em nosso painel e permite estendê-los para uso em sua aplicação. Ela se esforça para ser RESTful e está organizada em torno dos principais recursos com os quais você estaria interagindo - com algumas exceções notáveis.`}),`\n`,_jsx(Heading,{level:`3`,id:`requisições-de-exemplo`,children:`Requisições de Exemplo`}),`\n`,_jsxs(_components.p,{children:[`Fornecemos chamadas de API de exemplo ao lado de cada método `,_jsx(_components.a,{href:`https://curl.se/`,children:`usando cURL`}),`. Tudo o que você precisa fazer é inserir seus parâmetros específicos e testar as chamadas pela linha de comando. Veja este tutorial sobre `,_jsx(_components.a,{href:`https://www.baeldung.com/curl-rest`,children:`usando cURL com APIs`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Você também pode `,_jsx(_components.a,{href:`https://www.postman.com/downloads/`,children:`usar o Postman`}),` se não estiver familiarizado com o cURL. O Postman é uma plataforma fácil de usar para desenvolvimento e teste de APIs. Você pode explorar a `,_jsx(_components.a,{href:`https://www.postman.com/winter-moon-201761/yiksi-pay-api/collection/52598694-2844112a-6a69-4035-8b27-aa1f2bb12b89/?action=share\u0026creator=0`,children:`Coleção do Postman do Yiksi Pay`}),` para entender como nossas APIs funcionam.`]}),`\n`,_jsx(Heading,{level:`3`,id:`requisições-e-respostas`,children:`Requisições e Respostas`}),`\n`,_jsx(_components.p,{children:`Tanto os dados do corpo da requisição quanto os dados da resposta são formatados como JSON. O tipo de conteúdo para respostas será sempre application/json. Geralmente, todas as respostas estarão no seguinte formato:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"statusCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"[number]\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"[string]\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"[object]\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`chaves`,children:`Chaves`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Propriedade`}),_jsx(_components.th,{children:`Tipo`}),_jsx(_components.th,{children:`Descrição`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`statusCode`}),_jsx(_components.td,{children:`number`}),_jsx(_components.td,{children:`Este é o código de status da requisição que permite saber se sua requisição foi bem-sucedida ou não. Recomendamos que você use isso para determinar o resultado de uma chamada de API.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`message`}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Este é um resumo da resposta e seu status. Por exemplo, ao tentar recuperar uma lista de clientes, a mensagem pode dizer “Transações obtidas com sucesso”. No caso de um erro, a chave message conterá uma descrição do erro, como na situação do cabeçalho de autorização acima. Esta é a única chave que é universal em todas as requisições.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`data`}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`Contém os resultados da sua requisição. Pode ser um objeto ou um array, dependendo da requisição feita. Por exemplo, uma requisição para recuperar uma única transação retornará um objeto de transação na chave data, enquanto a chave seria um array de transações se uma lista for solicitada.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`objeto-meta`,children:`Objeto Meta`}),`\n`,_jsx(_components.p,{children:`A chave meta é usada para fornecer contexto para o conteúdo da chave data. Por exemplo, se uma lista de transações realizadas por um cliente estiver sendo recuperada, parâmetros de paginação podem ser passados para limitar o conjunto de resultados. A chave meta conterá então um objeto com os seguintes atributos:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"meta\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"totalItems\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`704`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"itemCount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`100`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"itemsPerPage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`100`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"totalPages\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`8`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"currentPage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Propriedade`}),_jsx(_components.th,{children:`Descrição`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`totalItems`}),_jsx(_components.td,{children:`O número total de itens disponíveis. Representa a contagem completa de itens em todas as páginas.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`itemCount`}),_jsx(_components.td,{children:`O número de itens na página atual. Indica quantos itens estão sendo retornados na resposta atual.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`itemsPerPage`}),_jsxs(_components.td,{children:[`O número máximo de itens por página. Define o limite de paginação definido para cada página. `,_jsx(_components.strong,{children:`Padrão: 100`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`totalPages`}),_jsx(_components.td,{children:`O número total de páginas disponíveis. É calculado com base no número total de itens e no número de itens por página.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`currentPage`}),_jsxs(_components.td,{children:[`O número da página atual. Indica qual página da paginação está sendo retornada na resposta atual. `,_jsx(_components.strong,{children:`Padrão: 1`})]})]})]})]})]})}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":"Introdução","description":"Aprenda como integrar perfeitamente nossas APIs em sua aplicação.","icon":"circle","href":"/pt/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Requisições de Exemplo","slug":"requisições-de-exemplo","depth":3,"children":[]},{"title":"Requisições e Respostas","slug":"requisições-e-respostas","depth":3,"children":[]},{"title":"Chaves","slug":"chaves","depth":3,"children":[]},{"title":"Objeto Meta","slug":"objeto-meta","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"yiksipay","siteName":"Yiksi Pay","title":"Introdução - Yiksi Pay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/api-reference/introduction","matchLevel":1},"es":{"href":"/es/api-reference/introduction","matchLevel":1},"pt":{"href":"/pt/api-reference/introduction","matchLevel":0},"fr":{"href":"/fr/api-reference/introduction","matchLevel":1},"zh":{"href":"/zh/api-reference/introduction","matchLevel":1}}},"lastModified":"2026-03-24T07:05:52.807Z","originalFileLocation":"pt/api-reference/introduction.mdx","locale":"pt"},"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=\"Aprenda como integrar perfeitamente nossas APIs em sua aplicação.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Yiksi Pay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introdução - Yiksi Pay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Aprenda como integrar perfeitamente nossas APIs em sua aplicação.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Yiksi Pay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.yiksipay.com/pt/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://yiksipay.mintlify.app/_mintlify/api/og/v2?division=Documenta%C3%A7%C3%A3o+da+API\u0026amp;title=Introdu%C3%A7%C3%A3o\u0026amp;description=Aprenda+como+integrar+perfeitamente+nossas+APIs+em+sua+aplica%C3%A7%C3%A3o.\u0026amp;theme=6e29a626a789cb40e8329fa5\u0026amp;signature=585ffca70415d0c343792786e12269b9ba2be593eb41e2c059c3ca3be378aa3d\">\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=\"Introdução - Yiksi Pay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Aprenda como integrar perfeitamente nossas APIs em sua aplicação.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://yiksipay.mintlify.app/_mintlify/api/og/v2?division=Documenta%C3%A7%C3%A3o+da+API\u0026amp;title=Introdu%C3%A7%C3%A3o\u0026amp;description=Aprenda+como+integrar+perfeitamente+nossas+APIs+em+sua+aplica%C3%A7%C3%A3o.\u0026amp;theme=6e29a626a789cb40e8329fa5\u0026amp;signature=585ffca70415d0c343792786e12269b9ba2be593eb41e2c059c3ca3be378aa3d\">\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/yiksipay/8MBDMq_4S2nKSqAD/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Yiksi Pay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6B53E2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.yiksipay.com/pt/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pt/api-reference/introduction.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt\" href=\"https://docs.yiksipay.com/pt/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.yiksipay.com/en/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.yiksipay.com/es/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.yiksipay.com/fr/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.yiksipay.com/zh/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.yiksipay.com/en/api-reference/introduction\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.yiksipay.com/#organization\",\"name\":\"Yiksi Pay\",\"url\":\"https://docs.yiksipay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/yiksipay/4IZNODSIyaoI_2s_/logo/light.png?fit=max\u0026auto=format\u0026n=4IZNODSIyaoI_2s_\u0026q=85\u0026s=6d5bc3bce8ca8b192d20804f89f45456\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.yiksipay.com#website\",\"name\":\"Yiksi Pay\",\"url\":\"https://docs.yiksipay.com\",\"publisher\":{\"@id\":\"https://docs.yiksipay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.yiksipay.com/pt/api-reference/introduction#webpage\",\"url\":\"https://docs.yiksipay.com/pt/api-reference/introduction\",\"name\":\"Introdução\",\"description\":\"Aprenda como integrar perfeitamente nossas APIs em sua aplicação.\",\"dateModified\":\"2026-03-24T07:05:52.807Z\",\"isPartOf\":{\"@id\":\"https://docs.yiksipay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.yiksipay.com/pt/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.yiksipay.com/pt/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Yiksi Pay\",\"item\":\"https://docs.yiksipay.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introdução\",\"item\":\"https://docs.yiksipay.com/pt/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.yiksipay.com/pt/api-reference/introduction#article\",\"headline\":\"Introdução\",\"name\":\"Introdução\",\"description\":\"Aprenda como integrar perfeitamente nossas APIs em sua aplicação.\",\"url\":\"https://docs.yiksipay.com/pt/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.yiksipay.com/pt/api-reference/introduction#webpage\"},\"dateModified\":\"2026-03-24T07:05:52.807Z\",\"publisher\":{\"@id\":\"https://docs.yiksipay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.yiksipay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Yiksi Pay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Yiksi Pay","nav":{"global":null,"languages":[{"language":"en","pages":[{"title":"en","href":"/en/api-reference/introduction"}]},{"language":"es","pages":[{"title":"es","href":"/es/api-reference/introduction"}]},{"language":"pt","tabs":[{"tab":"Documentação","pages":[{"title":"Documentação","href":"/pt/introduction"}]},{"tab":"Referência da API","groups":[{"group":"Documentação da API","pages":[{"title":"Introdução","icon":"circle","href":"/pt/api-reference/introduction"},{"title":"Autenticação","description":"Autentique suas chamadas de API incluindo sua chave de API no cabeçalho da requisição de cada requisição que você fizer. Você pode gerenciar suas chaves de API no [painel](https://dashboard.yiksipay.com/developers).","icon":"lock","href":"/pt/api-reference/authentication"},{"title":"Erros","icon":"exclamation","href":"/pt/api-reference/errors"}]},{"group":"Carteira Principal","pages":[{"openapi":"get /v1/wallets/{walletId}","title":"Get Wallet","href":"/pt/api-reference/wallet/get-wallet"},{"openapi":"patch /v1/wallets/{walletId}","title":"Update wallet","href":"/pt/api-reference/wallet/update-wallet"},{"openapi":"get /v1/wallets/{walletId}/balance","title":"Get Balance","href":"/pt/api-reference/wallet/get-balance"},{"openapi":"get /v1/wallets/{walletId}/balances","title":"Get Balances","href":"/pt/api-reference/wallet/get-balances"},{"openapi":"post /v1/wallets/{walletId}/rescan/blocks","title":"Deposit Finder","href":"/pt/api-reference/wallet/deposit-finder"},{"openapi":"post /v1/wallets/{walletId}/sweep/assets","title":"Trigger Sweep Assets","href":"/pt/api-reference/wallet/trigger-sweep-assets"},{"openapi":"get /v1/wallets/{walletId}/webhooks","title":"Webhooks Logs","href":"/pt/api-reference/wallet/webhooks-logs"}]},{"group":"Endereço","pages":[{"openapi":"get /v1/wallets/{walletId}/addresses","title":"Get Addresses","href":"/pt/api-reference/addresses/get-addresses"},{"openapi":"post /v1/wallets/{walletId}/addresses","title":"Generate Address","href":"/pt/api-reference/addresses/generate-address"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}","title":"Get Address","href":"/pt/api-reference/addresses/get-address"},{"openapi":"patch /v1/wallets/{walletId}/addresses/{addressId}","title":"Update Address","href":"/pt/api-reference/addresses/update-address"},{"openapi":"post /v1/wallets/{walletId}/addresses/whitelist","title":"Whitelist address","href":"/pt/api-reference/addresses/whitelist-address"},{"openapi":"delete /v1/wallets/{walletId}/addresses/whitelist/{addressId}","title":"Unwhitelist address","href":"/pt/api-reference/addresses/unwhitelist-address"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/balance","title":"Get Balance","href":"/pt/api-reference/addresses/get-balance"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/balances","title":"Get Balances","href":"/pt/api-reference/addresses/get-balances"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/transactions","title":"Get transactions","href":"/pt/api-reference/addresses/get-transactions"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/transactions/{id}","title":"Get transaction","href":"/pt/api-reference/addresses/get-transaction"}]},{"group":"Saque","pages":[{"openapi":"post /v1/wallets/{walletId}/withdraw/network-fee","title":"Master Wallet Network Fee","href":"/pt/api-reference/withdraw/master-wallet-network-fee"},{"openapi":"post /v1/wallets/{walletId}/withdraw","title":"Master Wallet","href":"/pt/api-reference/withdraw/master-wallet"},{"openapi":"post /v1/wallets/{walletId}/withdraw/sign","title":"Master Wallet Sign-Only","href":"/pt/api-reference/withdraw/master-wallet-sign-only"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/withdraw","title":"Child Address","href":"/pt/api-reference/withdraw/child-address"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/withdraw/sign","title":"Child Address Sign-Only","href":"/pt/api-reference/withdraw/child-address-sign-only"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/withdraw/network-fee","title":"Child Address Network Fee","href":"/pt/api-reference/withdraw/child-address-network-fee"}]},{"group":"Troca","pages":[{"openapi":"post /v1/wallets/{walletId}/swaps/quote","title":"Master Wallet Get Quote","href":"/pt/api-reference/swap/master-wallet-get-quote"},{"openapi":"post /v1/wallets/{walletId}/swaps/execute","title":"Master Wallet Execute","href":"/pt/api-reference/swap/master-wallet-execute"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/swaps/quote","title":"Child Address Get Quote","href":"/pt/api-reference/swap/child-address-get-quote"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/swaps/execute","title":"Child Address Execute","href":"/pt/api-reference/swap/child-address-execute"}]},{"group":"Contratos Inteligentes","pages":[{"openapi":"post /v1/wallets/{walletId}/contracts/network-fee","title":"Master Wallet Network Fee","href":"/pt/api-reference/smart-contract/master-wallet-network-fee"},{"openapi":"post /v1/wallets/{walletId}/contracts/read","title":"Master Wallet Read","href":"/pt/api-reference/smart-contract/master-wallet-read"},{"openapi":"post /v1/wallets/{walletId}/contracts/write","title":"Master Wallet Write","href":"/pt/api-reference/smart-contract/master-wallet-write"},{"openapi":"post /v1/wallets/{walletId}/contracts/write/sign","title":"Master Wallet Write Sign-Only","href":"/pt/api-reference/smart-contract/master-wallet-write-sign-only"},{"openapi":"post /wallets/{walletId}/addresses/{addressId}/contracts/network-fee","title":null,"href":"/pt/api-reference/smart-contract/child-address-network-fee"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/contracts/read","title":"Child Address Read","href":"/pt/api-reference/smart-contract/child-address-read"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/contracts/write","title":"Child Address Write","href":"/pt/api-reference/smart-contract/child-address-write"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/contracts/write/sign","title":"Child Address Write Sign-Only","href":"/pt/api-reference/smart-contract/child-address-write-sign-only"}]},{"group":"Assinatura","pages":[{"openapi":"post /v1/wallets/{walletId}/signing/typed-data","title":"Master Wallet Typed data","href":"/pt/api-reference/signing/master-wallet-typed-data"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/signing/typed-data","title":"Child Address Typed data","href":"/pt/api-reference/signing/child-address-typed-data"}]},{"group":"Gestão de Ativos","pages":[{"openapi":"get /v1/wallets/{walletId}/assets","title":"Get Wallet Assets","href":"/pt/api-reference/asset/get-wallet-assets"},{"openapi":"post /v1/wallets/{walletId}/assets","title":"Add Asset to Wallet","href":"/pt/api-reference/asset/add-asset-to-wallet"},{"openapi":"delete /v1/wallets/{walletId}/assets/{assetId}","title":"Remove Asset from Wallet","href":"/pt/api-reference/asset/remove-asset-from-wallet"},{"openapi":"patch /v1/wallets/{walletId}/assets/{assetId}","title":"Update Wallet Asset","href":"/pt/api-reference/asset/update-wallet-asset"}]},{"group":"Transações","pages":[{"openapi":"get /v1/wallets/{walletId}/transactions","title":"Get Transactions","href":"/pt/api-reference/transactions/get-transactions"},{"openapi":"get /v1/wallets/{walletId}/transactions/{id}","title":"Get transaction","href":"/pt/api-reference/transactions/get-transaction"},{"openapi":"post /v1/wallets/{walletId}/transactions/webhooks/resend","title":"Resend Webhook","href":"/pt/api-reference/transactions/resend-webhook"},{"openapi":"post /v1/wallets/{walletId}/transactions/sweep/assets","title":"Trigger Asset Sweep","href":"/pt/api-reference/transactions/trigger-asset-sweep"},{"openapi":"get /v1/wallets/{walletId}/transactions/{transactionsId}/webhooks","title":"Webhook Logs","href":"/pt/api-reference/transactions/webhook-logs"},{"openapi":"post /v1/wallets/{walletId}/transactions/cancel","title":"Cancel Transaction","href":"/pt/api-reference/transactions/cancel-transaction"},{"openapi":"post /v1/wallets/{walletId}/transactions/retry","title":"Retry Transaction","href":"/pt/api-reference/transactions/retry-transaction"}]},{"group":"AML","pages":[{"openapi":"get /v1/aml/lookup","title":"Lookup","href":"/pt/api-reference/aml/lookup"}]},{"group":"Liquidações Automáticas","pages":[{"openapi":"get /v1/wallets/{walletId}/auto-settlements","title":"Master Wallet","href":"/pt/api-reference/auto-settlements/master-wallet"},{"openapi":"patch /v1/wallets/{walletId}/auto-settlements","title":"Master Wallet Update","href":"/pt/api-reference/auto-settlements/master-wallet-update"},{"openapi":"get /v1/wallets/{walletId}/auto-settlements/rules","title":"Master Wallet Get Rules","href":"/pt/api-reference/auto-settlements/master-wallet-get-rules"},{"openapi":"get /v1/wallets/{walletId}/auto-settlements/rules/{id}","title":"Master Wallet Get Rule","href":"/pt/api-reference/auto-settlements/master-wallet-get-rule"},{"openapi":"post /v1/wallets/{walletId}/auto-settlements/rules","title":"Master Wallet Create Rule","href":"/pt/api-reference/auto-settlements/master-wallet-create-rule"},{"openapi":"patch /v1/wallets/{walletId}/auto-settlements/rules/{id}","title":"Master Wallet Update Rule","href":"/pt/api-reference/auto-settlements/master-wallet-update-rule"},{"openapi":"delete /v1/wallets/{walletId}/auto-settlements/rules/{id}","title":"Master Wallet Delete Rule","href":"/pt/api-reference/auto-settlements/master-wallet-delete-rule"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements","title":"Child Address","href":"/pt/api-reference/auto-settlements/child-address"},{"openapi":"patch /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements","title":"Child Address Update","href":"/pt/api-reference/auto-settlements/child-address-update"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules","title":"Child Address Get Rules","href":"/pt/api-reference/auto-settlements/child-address-get-rules"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}","title":"Child Address Get Rule","href":"/pt/api-reference/auto-settlements/child-address-get-rule"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules","title":"Child Address Create Rule","href":"/pt/api-reference/auto-settlements/child-address-create-rule"},{"openapi":"patch /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}","title":"Child Address Update Rule","href":"/pt/api-reference/auto-settlements/child-address-update-rule"},{"openapi":"delete /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}","title":"Child Address Delete Rule","href":"/pt/api-reference/auto-settlements/child-address-delete-rule"}]},{"group":"Beneficiários","pages":[{"openapi":"post /v1/wallets/{walletId}/beneficiaries","title":"Create","href":"/pt/api-reference/beneficiaries/create"},{"openapi":"get /v1/wallets/{walletId}/beneficiaries","title":"Get all","href":"/pt/api-reference/beneficiaries/get-all"},{"openapi":"get /v1/wallets/{walletId}/beneficiaries/{id}","title":"Get one","href":"/pt/api-reference/beneficiaries/get-one"},{"openapi":"patch /v1/wallets/{walletId}/beneficiaries/{id}","title":"Update","href":"/pt/api-reference/beneficiaries/update"},{"openapi":"delete /v1/wallets/{walletId}/beneficiaries/{id}","title":"Delete","href":"/pt/api-reference/beneficiaries/delete"}]},{"group":"Recuperação de Ativos","pages":[{"openapi":"post /v1/wallets/{walletId}/salvage/network-fee","title":"Network Fee","href":"/pt/api-reference/asset-recovery/salvage-network-fee"},{"openapi":"post /v1/wallets/{walletId}/salvage","title":"Execute","href":"/pt/api-reference/asset-recovery/salvage"}]},{"group":"Diversos","pages":[{"openapi":"get /v1/assets","title":"Get Assets","href":"/pt/api-reference/miscellaneous/get-assets"},{"openapi":"get /v1/blockchains","title":"Get Blockchains","href":"/pt/api-reference/miscellaneous/get-blockchains"},{"openapi":"get /v1/assets/rates","title":"Get Rates","href":"/pt/api-reference/miscellaneous/get-rates"}]}]},{"tab":"Segurança","pages":[{"title":"Segurança","href":"/pt/security/introduction"}]}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/api-reference/introduction"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/api-reference/introduction"}]}]},"basePath":"","title":"Introdução - Yiksi Pay","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}
