Every endpoint an API key can call, generated from the API’s own code.
The pages in this section are generated from the Payve API’s controllers and request models. Each one lists the method, path, parameters and request body for an endpoint.For worked examples, response fields and failure cases, read the guide for each area. The reference tells you what an endpoint accepts. The guides tell you how to use it.
Base URL
https://api.payvehq.com
Every path starts with /v1. The sandbox is at https://sandbox.api.payvehq.com. See Environments.
Authentication
Send your secret key in the x-api-key header. See Authentication.
Reading needs no particular scope. Any valid key can call the GET endpoints for its own account.
These pages show endpoints without a “send request” console, so that nobody moves live money from
a documentation page by accident. Use cURL or your own code.
Not in this reference
Endpoints the dashboard uses, such as creating API keys and managing webhook endpoints, need a dashboard session and are not part of the public API.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Payve","description":"Developer documentation for the Payve API: send, collect and convert money across African corridors.","colors":{"primary":"#2D4EDE","light":"#8FA2F5","dark":"#2340C4"},"logo":{"light":"/logo-light.png","dark":"/logo-dark.png","href":"https://payvehq.com"},"favicon":"/favicon.png","api":{"playground":{"display":"interactive","proxy":false},"examples":{"languages":["curl","javascript","python","php"]}},"navbar":{"links":[{"href":"mailto:support@payvehq.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.payvehq.com"}},"footer":{"links":[{"header":"Payve","items":[{"label":"Website","href":"https://payvehq.com"},{"label":"Dashboard","href":"https://app.payvehq.com"}]},{"header":"Help","items":[{"label":"Get help","href":"/support"},{"label":"Changelog","href":"/changelog"}]}]},"seo":{"metatags":{"canonical":"https://docs.payvehq.com"}},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"hasAudioNarration":false,"customDomains":[],"gitSource":{"type":"github","owner":"local","repo":"local","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"local","isBase":true},"buildId":"local","clientVersion":"0.0.4231"},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false,"isLoggedInCli":false},"customCss":[{"filePath":"style.css","content":":root{--sidebar-width: 14.5rem}#header .prose.text-lg{font-size:1rem;line-height:1.6}:root{--pva-bg: #ffffff;--pva-ink: #14172a;--pva-muted: #5b6078;--pva-line: #e4e6ef;--pva-soft: #f4f5fa;--pva-brand: #2d4ede;--pva-brand-ink: #ffffff}.dark{--pva-bg: #12141f;--pva-ink: #f4f5fa;--pva-muted: #a3a8bd;--pva-line: #2a2e42;--pva-soft: #1b1e2d;--pva-brand: #5b78f0;--pva-brand-ink: #0b0d17}#search-bar-entry [data-search-item=\"trigger-hint\"]{display:none}.pva-inline{display:inline-flex;flex:none;align-items:center;gap:5px;margin-left:8px;padding:3px 9px;border-radius:999px;background:var(--pva-brand);color:var(--pva-brand-ink);font-size:12px;font-weight:600;line-height:1.5;cursor:pointer}.pva-inline:hover{filter:brightness(1.1)}.pva-inline:focus-visible,.pva-send:focus-visible,.pva-close:focus-visible,.pva-chip:focus-visible{outline:2px solid var(--pva-brand);outline-offset:2px}.pva-overlay{position:fixed;inset:0;z-index:70;display:flex;justify-content:center;align-items:flex-start;padding:10vh 16px 16px;background:rgba(10, 12, 22, 0.45);backdrop-filter:blur(2px)}.pva-overlay[hidden]{display:none}.pva-panel{display:flex;flex-direction:column;width:min(640px, 100%);height:min(620px, 78vh);border:1px solid var(--pva-line);border-radius:16px;background:var(--pva-bg);color:var(--pva-ink);font-size:14px;line-height:1.55;box-shadow:0 24px 60px rgba(20, 23, 42, 0.32);overflow:hidden}.pva-head{display:flex;align-items:center;justify-content:space-between;padding:14px 16px;border-bottom:1px solid var(--pva-line)}.pva-head strong{display:block;font-size:15px}.pva-sub{color:var(--pva-muted);font-size:12px}.pva-close{width:30px;height:30px;border:0;border-radius:8px;background:transparent;color:var(--pva-muted);font-size:20px;line-height:1;cursor:pointer}.pva-close:hover{background:var(--pva-soft)}.pva-log{flex:1;display:flex;flex-direction:column;gap:10px;padding:16px;overflow-y:auto}.pva-welcome p{margin:0 0 10px;color:var(--pva-muted)}.pva-chip{display:block;width:100%;margin-bottom:8px;padding:9px 12px;border:1px solid var(--pva-line);border-radius:10px;background:transparent;color:var(--pva-ink);font:inherit;text-align:left;cursor:pointer}.pva-chip:hover{border-color:var(--pva-brand)}.pva-msg{max-width:92%;padding:10px 12px;border-radius:12px;overflow-wrap:anywhere}.pva-user{align-self:flex-end;background:var(--pva-brand);color:var(--pva-brand-ink)}.pva-bot{align-self:flex-start;background:var(--pva-soft)}.pva-wait{color:var(--pva-muted)}.pva-bot p{margin:0 0 8px}.pva-bot p:last-child{margin-bottom:0}.pva-list{margin:0 0 8px;padding-left:20px}.pva-bot code,.pva-code{font-family:ui-monospace, SFMono-Regular, Menlo, monospace;font-size:12.5px}.pva-bot code{padding:1px 5px;border-radius:5px;background:var(--pva-line)}.pva-code{margin:0 0 8px;padding:10px;border-radius:8px;background:var(--pva-bg);border:1px solid var(--pva-line);overflow-x:auto;white-space:pre}.pva-sources{display:flex;flex-wrap:wrap;gap:6px;margin-top:10px;padding-top:10px;border-top:1px solid var(--pva-line)}.pva-sources-label{width:100%;color:var(--pva-muted);font-size:12px}.pva-source{padding:4px 9px;border:1px solid var(--pva-line);border-radius:999px;background:var(--pva-bg);color:var(--pva-brand);font-size:12px;text-decoration:none}.pva-source:hover{border-color:var(--pva-brand)}.pva-form{display:flex;gap:8px;padding:12px 16px 8px;border-top:1px solid var(--pva-line)}.pva-input{flex:1;min-height:40px;max-height:120px;padding:9px 12px;border:1px solid var(--pva-line);border-radius:10px;background:var(--pva-bg);color:var(--pva-ink);font:inherit;resize:none}.pva-input:focus{outline:2px solid var(--pva-brand);outline-offset:0}.pva-send{padding:0 16px;border:0;border-radius:10px;background:var(--pva-brand);color:var(--pva-brand-ink);font:600 14px/1 inherit;cursor:pointer}.pva-send:disabled{opacity:0.5;cursor:default}.pva-foot{margin:0;padding:0 16px 12px;color:var(--pva-muted);font-size:11.5px}.pvs-overlay{position:fixed;inset:0;z-index:70;display:flex;justify-content:center;align-items:flex-start;padding:12vh 16px 16px;background:rgba(10, 12, 22, 0.45);backdrop-filter:blur(2px)}.pvs-overlay[hidden]{display:none}.pvs-box{display:flex;flex-direction:column;width:min(640px, 100%);max-height:70vh;border:1px solid var(--pva-line);border-radius:16px;background:var(--pva-bg);color:var(--pva-ink);box-shadow:0 24px 60px rgba(20, 23, 42, 0.32);overflow:hidden}.pvs-input{width:100%;padding:16px 18px;border:0;border-bottom:1px solid var(--pva-line);background:transparent;color:var(--pva-ink);font:inherit;font-size:16px;outline:none}.pvs-list{flex:1;padding:8px;overflow-y:auto}.pvs-empty{margin:0;padding:18px 10px;color:var(--pva-muted);font-size:14px}.pvs-row{display:block;padding:10px 12px;border-radius:10px;color:var(--pva-ink);text-decoration:none}.pvs-row strong{display:block;font-size:14px}.pvs-row span{display:block;margin-top:2px;color:var(--pva-muted);font-size:13px;line-height:1.45;overflow-wrap:anywhere}.pvs-on{background:var(--pva-soft);box-shadow:inset 2px 0 0 var(--pva-brand)}.pvs-foot{display:flex;align-items:center;justify-content:space-between;gap:12px;padding:10px 14px;border-top:1px solid var(--pva-line);color:var(--pva-muted);font-size:12px}.pvs-ask{padding:6px 12px;border:1px solid var(--pva-line);border-radius:999px;background:transparent;color:var(--pva-brand);font:600 12px/1 inherit;cursor:pointer}.pvs-ask:hover{border-color:var(--pva-brand)}"}]}
{"page":{"pagePath":"api-reference/overview","slug":"/api-reference/overview","pageMetadata":{"title":"API reference","description":"Every endpoint an API key can call, generated from the API's own code.","href":"/api-reference/overview"},"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: \"Every endpoint an API key can call, generated from the API’s own code.\"\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`,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(_components.p,{children:`The pages in this section are generated from the Payve API’s controllers and request models. Each one lists the method, path, parameters and request body for an endpoint.`}),`\n`,_jsx(_components.p,{children:`For worked examples, response fields and failure cases, read the guide for each area. The reference tells you what an endpoint accepts. The guides tell you how to use it.`}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.payvehq.com`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Every path starts with `,_jsx(_components.code,{children:`/v1`}),`. The sandbox is at `,_jsx(_components.code,{children:`https://sandbox.api.payvehq.com`}),`. See `,_jsx(_components.a,{href:`/get-started/environments`,children:`Environments`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`Send your secret key in the `,_jsx(_components.code,{children:`x-api-key`}),` header. See `,_jsx(_components.a,{href:`/get-started/authentication`,children:`Authentication`}),`.`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.payvehq.com/v1/wallets\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-api-key: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$PAYVE_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Two endpoints need no key: `,_jsx(_components.code,{children:`GET /v1/currencies`}),` and `,_jsx(_components.code,{children:`GET /v1/rates`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`conventions`,children:`Conventions`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Topic`}),_jsx(_components.th,{children:`Rule`}),_jsx(_components.th,{children:`More`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Amounts`}),_jsx(_components.td,{children:`Integers in minor units in requests. Strings of digits in responses.`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/essentials/requests-and-responses#amounts`,children:`Requests and responses`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Ids`}),_jsxs(_components.td,{children:[`Numeric `,_jsx(_components.code,{children:`id`}),` in payout, pay-in and conversion URLs. Prefixed ids elsewhere.`]}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/essentials/requests-and-responses#ids`,children:`Ids`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Idempotency`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`Idempotency-Key`}),` is required on payouts, pay-ins and conversions.`]}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/essentials/idempotency`,children:`Idempotency`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Responses`}),_jsxs(_components.td,{children:[`Results are wrapped in `,_jsx(_components.code,{children:`data`}),`.`]}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/essentials/requests-and-responses#responses`,children:`Responses`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Errors`}),_jsxs(_components.td,{children:[`An `,_jsx(_components.code,{children:`error`}),` object with a `,_jsx(_components.code,{children:`code`}),`.`]}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/essentials/errors`,children:`Errors`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Pagination`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`cursor`}),` and `,_jsx(_components.code,{children:`limit`}),` on the main lists.`]}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/essentials/requests-and-responses#pagination`,children:`Pagination`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Rate limit`}),_jsx(_components.td,{children:`200 requests per minute per IP address.`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/essentials/rate-limits`,children:`Rate limits`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`endpoints-by-area`,children:`Endpoints by area`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Area`}),_jsx(_components.th,{children:`Guide`}),_jsx(_components.th,{children:`Scope needed to write`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Quotes`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/guides/quotes`,children:`Quotes`})}),_jsx(_components.td,{children:`None`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Payouts`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/guides/payouts`,children:`Payouts`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`payouts:write`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Pay-ins`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/guides/payins`,children:`Pay-ins`})}),_jsx(_components.td,{children:`None`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Payment links`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/guides/payment-links`,children:`Payment links`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`payins:write`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Conversions`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/guides/conversions`,children:`Conversions`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`conversions:write`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Wallets`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/guides/wallets`,children:`Wallets`})}),_jsx(_components.td,{children:`None`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Beneficiaries`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/guides/beneficiaries`,children:`Beneficiaries`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`beneficiaries:write`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Refunds`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/guides/refunds`,children:`Refunds`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`payouts:write`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Statements`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/guides/statements`,children:`Statements`})}),_jsx(_components.td,{children:`Read only by API key`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Webhooks`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/webhooks/overview`,children:`Webhooks`})}),_jsx(_components.td,{children:`Read only by API key`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Reading needs no particular scope. Any valid key can call the `,_jsx(_components.code,{children:`GET`}),` endpoints for its own account.`]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`These pages show endpoints without a “send request” console, so that nobody moves live money from\na documentation page by accident. Use cURL or your own code.`})}),`\n`,_jsx(Heading,{level:`2`,id:`not-in-this-reference`,children:`Not in this reference`}),`\n`,_jsx(_components.p,{children:`Endpoints the dashboard uses, such as creating API keys and managing webhook endpoints, need a dashboard session and are not part of the public API.`})]})}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":"API reference","description":"Every endpoint an API key can call, generated from the API's own code.","href":"/api-reference/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Conventions","slug":"conventions","depth":2,"children":[]},{"title":"Endpoints by area","slug":"endpoints-by-area","depth":2,"children":[]},{"title":"Not in this reference","slug":"not-in-this-reference","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/docs.payvehq.com/d641fece004526ca/assistant.js","/_mintlify/custom/docs.payvehq.com/b79553cf5a1ed2d6/search-index.js","/_mintlify/custom/docs.payvehq.com/3ca8c8799f334a99/search.js"],"subdomain":"docs.payvehq.com","siteName":"Payve","title":"API reference - Payve","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/overview.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Every endpoint an API key can call, generated from the API\u0026#x27;s own code.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Payve\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/favicons/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/favicons/favicon-32x32.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/favicons/favicon-16x16.png\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/favicons/favicon.ico\">\u003cmeta data-mint-head property=\"og:title\" content=\"API reference - Payve\">\u003cmeta data-mint-head property=\"og:description\" content=\"Every endpoint an API key can call, generated from the API\u0026#x27;s own code.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Payve\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.payvehq.com/api-reference/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"http://docs.payvehq.com/_mintlify/og/api-reference/overview.png\">\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=\"API reference - Payve\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Every endpoint an API key can call, generated from the API\u0026#x27;s own code.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"http://docs.payvehq.com/_mintlify/og/api-reference/overview.png\">\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=\"/favicons/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Payve\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2D4EDE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.payvehq.com/api-reference/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Payve\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Payve\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/overview.md","siteName":"Payve","nav":{"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","icon":"code","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/overview"}]},{"group":"Quotes","pages":[{"title":"Create quote","description":"Lock an exchange rate for five minutes. Pass the quote id when you create a conversion or a payout in another currency.","openapi":"/openapi.json post /v1/quotes","href":"/api-reference/quotes/create-quote"},{"title":"List quotes","openapi":"/openapi.json get /v1/quotes","href":"/api-reference/quotes/list-quotes"},{"title":"Get quote","openapi":"/openapi.json get /v1/quotes/{id}","href":"/api-reference/quotes/get-quote"}]},{"group":"Payouts","pages":[{"title":"Create payout","openapi":"/openapi.json post /v1/payouts","href":"/api-reference/payouts/create-payout"},{"title":"Bulk payout","openapi":"/openapi.json post /v1/payouts/bulk","href":"/api-reference/payouts/bulk-payout"},{"title":"List payouts","openapi":"/openapi.json get /v1/payouts","href":"/api-reference/payouts/list-payouts"},{"title":"Get payout","openapi":"/openapi.json get /v1/payouts/{id}","href":"/api-reference/payouts/get-payout"},{"title":"List institutions","openapi":"/openapi.json get /v1/payouts/institutions","href":"/api-reference/payouts/list-institutions"},{"title":"Check account","openapi":"/openapi.json get /v1/payouts/validate-account","href":"/api-reference/payouts/check-account"},{"title":"Resend webhook","openapi":"/openapi.json post /v1/payouts/{id}/resend-webhook","href":"/api-reference/payouts/resend-webhook"}]},{"group":"Collections","pages":[{"title":"Create pay-in","openapi":"/openapi.json post /v1/payins","href":"/api-reference/payins/create-pay-in"},{"title":"List pay-ins","openapi":"/openapi.json get /v1/payins","href":"/api-reference/payins/list-pay-ins"},{"title":"Get pay-in","openapi":"/openapi.json get /v1/payins/{id}","href":"/api-reference/payins/get-pay-in"},{"title":"Authorize pay-in","openapi":"/openapi.json post /v1/payins/{id}/authorize","href":"/api-reference/payins/authorize-pay-in"},{"title":"Refresh status","openapi":"/openapi.json post /v1/payins/{id}/validate","href":"/api-reference/payins/refresh-status"},{"title":"Resend webhook","openapi":"/openapi.json post /v1/payins/{id}/resend-webhook","href":"/api-reference/payins/resend-webhook"}]},{"group":"Payment links","pages":[{"title":"Create link","openapi":"/openapi.json post /v1/payment-links","href":"/api-reference/payment-links/create-link"},{"title":"List links","openapi":"/openapi.json get /v1/payment-links","href":"/api-reference/payment-links/list-links"},{"title":"Get link","openapi":"/openapi.json get /v1/payment-links/{id}","href":"/api-reference/payment-links/get-link"},{"title":"Update link","openapi":"/openapi.json patch /v1/payment-links/{id}","href":"/api-reference/payment-links/update-link"},{"title":"Delete link","openapi":"/openapi.json delete /v1/payment-links/{id}","href":"/api-reference/payment-links/delete-link"}]},{"group":"Conversions","pages":[{"title":"Create conversion","openapi":"/openapi.json post /v1/conversions","href":"/api-reference/conversions/create-conversion"},{"title":"List conversions","openapi":"/openapi.json get /v1/conversions","href":"/api-reference/conversions/list-conversions"},{"title":"Get conversion","openapi":"/openapi.json get /v1/conversions/{id}","href":"/api-reference/conversions/get-conversion"},{"title":"Resend webhook","openapi":"/openapi.json post /v1/conversions/{id}/resend-webhook","href":"/api-reference/conversions/resend-webhook"}]},{"group":"Wallets","pages":[{"title":"List wallets","openapi":"/openapi.json get /v1/wallets","href":"/api-reference/wallets/list-wallets"},{"title":"Create wallet","openapi":"/openapi.json post /v1/wallets","href":"/api-reference/wallets/create-wallet"},{"title":"Get wallet","openapi":"/openapi.json get /v1/wallets/{currency}","href":"/api-reference/wallets/get-wallet"},{"title":"Get wallet account","openapi":"/openapi.json get /v1/wallets/{currency}/va","href":"/api-reference/wallets/get-wallet-account"},{"title":"Request account","openapi":"/openapi.json post /v1/wallets/{currency}/request-va","href":"/api-reference/wallets/request-account"},{"title":"List accounts","openapi":"/openapi.json get /v1/wallets/virtual-accounts","href":"/api-reference/wallets/list-accounts"},{"title":"Get account","openapi":"/openapi.json get /v1/wallets/virtual-accounts/{id}","href":"/api-reference/wallets/get-account"}]},{"group":"Beneficiaries","pages":[{"title":"Create beneficiary","openapi":"/openapi.json post /v1/beneficiaries","href":"/api-reference/beneficiaries/create-beneficiary"},{"title":"List beneficiaries","openapi":"/openapi.json get /v1/beneficiaries","href":"/api-reference/beneficiaries/list-beneficiaries"},{"title":"Get beneficiary","openapi":"/openapi.json get /v1/beneficiaries/{id}","href":"/api-reference/beneficiaries/get-beneficiary"},{"title":"Archive beneficiary","openapi":"/openapi.json delete /v1/beneficiaries/{id}","href":"/api-reference/beneficiaries/archive-beneficiary"}]},{"group":"Refunds","pages":[{"title":"Create refund","openapi":"/openapi.json post /v1/refunds","href":"/api-reference/refunds/create-refund"},{"title":"List refunds","openapi":"/openapi.json get /v1/refunds","href":"/api-reference/refunds/list-refunds"},{"title":"Get refund","openapi":"/openapi.json get /v1/refunds/{id}","href":"/api-reference/refunds/get-refund"},{"title":"Process refund","openapi":"/openapi.json post /v1/refunds/{id}/process","href":"/api-reference/refunds/process-refund"}]},{"group":"Statements","pages":[{"title":"List statements","openapi":"/openapi.json get /v1/statements","href":"/api-reference/statements/list-statements"},{"title":"Get statement","openapi":"/openapi.json get /v1/statements/{id}","href":"/api-reference/statements/get-statement"},{"title":"Download statement","openapi":"/openapi.json get /v1/statements/{id}/download","href":"/api-reference/statements/download-statement"}]},{"group":"Webhooks","pages":[{"title":"List endpoints","openapi":"/openapi.json get /v1/webhooks/endpoints","href":"/api-reference/webhooks/list-endpoints"},{"title":"List events","openapi":"/openapi.json get /v1/webhooks/events","href":"/api-reference/webhooks/list-events"},{"title":"Get event","openapi":"/openapi.json get /v1/webhooks/events/{id}","href":"/api-reference/webhooks/get-event"}]},{"group":"Reference data","pages":[{"title":"List currencies","openapi":"/openapi.json get /v1/currencies","href":"/api-reference/reference-data/list-currencies"},{"title":"Get rates","openapi":"/openapi.json get /v1/rates","href":"/api-reference/reference-data/get-rates"}]}]},{"tab":"MCP","icon":"bot","pages":[{"title":"MCP","href":"/mcp/overview"}]}]},"basePath":"","title":"API reference - Payve","buildId":"6a8a261234c2","dynamics":[],"chunks":[]}