{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"API PayMee 1.1","colors":{"primary":"#E85A27","light":"#E85A27","dark":"#E85A27"},"logo":{"light":"https://paymee-public-cnd.s3.us-west-2.amazonaws.com/cropped-paymee-logo-transparent-blue.png","dark":"https://paymee-public-cnd.s3.us-west-2.amazonaws.com/cropped-paymee-logo-transparent-white.png"},"favicon":"https://mintcdn.com/paymee/7ylCVHUqKWDdiVAw/cropped-fav-180x180.png?fit=max\u0026auto=format\u0026n=7ylCVHUqKWDdiVAw\u0026q=85\u0026s=76a1191023f90a80d0912ea81fd9ebda","navbar":{"links":[{"href":"mailto:suporte@paymee.com.br","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://secure.paymee.com.br/"}},"footer":{"socials":{"github":"https://github.com/paymeebrasil?tab=repositories","linkedin":"https://www.linkedin.com/company/paymeebrasil"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Help","icon":"book-open-cover","href":"https://paymee.com.br/ajuda/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paymee","hasAudioNarration":false,"actualSubdomain":"paymee","customDomains":["developer.paymee.com.br"],"gitSource":{"type":"github","owner":"paymee-brasil","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ab44e17d5db156693951cb9","collectionId":"a27ca735-7487-4241-bb4c-148dc7cc74ce","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ab44e17d5db156693951cb9"},"entitlements":{},"buildId":"6ab44e17d5db156693951cb9","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":39},{"language":"default","tag":"Pix Automatic (Recurrence)","count":13},{"language":"default","tag":"API Documentation","count":5},{"language":"default","tag":"Transactions","count":4},{"language":"default","tag":"Payouts","count":4},{"language":"default","tag":"Split","count":3},{"language":"default","tag":"Loan","count":2},{"language":"default","tag":"Checkout","count":2},{"language":"default","tag":"Webhooks and Callbacks","count":2},{"language":"default","tag":"Financial","count":2}]},"assistantConfig":{},"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":"api-reference/checkouts/create","slug":"/api-reference/checkouts/create","pageMetadata":{"openapi":"post /v1.1/loans/create","title":"Create a loan","description":"Creates a loan based on a previously approved proposal","href":"/api-reference/checkouts/create"},"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: \"Creates a loan based on a previously approved proposal\"\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":{"openapi":"post /v1.1/loans/create","title":"Create a loan","description":"Creates a loan based on a previously approved proposal","href":"/api-reference/checkouts/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Checkouts","loans"],"summary":"Create a loan","description":"Creates a loan based on a previously approved proposal","operationId":"create","parameters":["20893ba6-2c66-495d-bb06-67b28ee97a50","985cce3e-e243-4f8a-b203-7fe56141e2fb"],"requestBody":"afd497ad-19e6-47ae-a87e-d78983e49e7b","responses":{"200":"fd3f42cb-8559-4b79-932b-9dbcaeb261f6","400":"f606caa3-86b6-48b2-99f6-930cff1cd259","403":"1eeb5257-1f22-413f-bc59-37ded7259aae"},"method":"post","type":"path","servers":["f2574027-ca15-4eff-9fc1-9afd9af507bb","ec2f7f3d-e147-414d-b0ee-e43f2c22bcad"],"security":[],"path":"/v1.1/loans/create","baseUrlOptions":["https://api.paymee.com.br","https://apisandbox.paymee.com.br"],"title":"Create a loan","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"20893ba6-2c66-495d-bb06-67b28ee97a50":{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string","example":"your-api-key-here","isRequired":true,"description":"API authentication key","uniqueKey":"","typeLabel":"string"},"description":"API authentication key"},"985cce3e-e243-4f8a-b203-7fe56141e2fb":{"name":"x-api-token","in":"header","required":true,"schema":{"type":"string","example":"your-api-token-here","isRequired":true,"description":"API authentication token","uniqueKey":"","typeLabel":"string"},"description":"API authentication token"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["proposal_id","reference_code","customer","final_amount","max_age","discriminator"],"properties":{"proposal_id":{"type":"string","description":"Proposal ID from a previous loan simulation","example":"abc1234","isRequired":true,"uniqueKey":"proposal_id","typeLabel":"string"},"reference_code":{"type":"string","description":"Merchant reference code for tracking","example":"ref01234","isRequired":true,"uniqueKey":"reference_code","typeLabel":"string"},"max_age":{"type":"integer","description":"Validity period in minutes","example":60,"isRequired":true,"uniqueKey":"max_age","typeLabel":"integer"},"discriminator":{"type":"string","description":"Optional field for categorization","example":"John's transaction","isRequired":true,"uniqueKey":"discriminator","typeLabel":"string"},"final_amount":{"type":"number","description":"Final amount to be paid","example":10,"isRequired":true,"uniqueKey":"final_amount","typeLabel":"number"},"customer":{"type":"object","required":["name","birth","email","mobile_number","document","address"],"properties":{"name":{"type":"string","description":"Customer's full name","example":"John Doe","isRequired":true,"uniqueKey":"customer.name","typeLabel":"string"},"birth":{"type":"string","format":"date","description":"Customer's birth date in YYYY-MM-DD format","example":"1970-01-01","isRequired":true,"uniqueKey":"customer.birth","typeLabel":"string\u003cdate>"},"email":{"type":"string","format":"email","description":"Customer email address","example":"foo@bar.com","isRequired":true,"uniqueKey":"customer.email","typeLabel":"string\u003cemail>"},"mobile_number":{"type":"string","description":"Customer mobile phone number","example":"11999999999","isRequired":true,"uniqueKey":"customer.mobile_number","typeLabel":"string"},"document":{"type":"object","required":["type","number"],"properties":{"type":{"type":"string","enum":["CPF","CNPJ"],"description":"Document type (CPF for individuals, CNPJ for companies)","example":"CPF","isRequired":true,"uniqueKey":"customer.document.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"Document number","example":"00000000000","isRequired":true,"uniqueKey":"customer.document.number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"customer.document","typeLabel":"object"},"address":{"type":"object","required":["zipcode","street","number","city","state"],"properties":{"zipcode":{"type":"string","description":"Postal code","example":"12345678","isRequired":true,"uniqueKey":"customer.address.zipcode","typeLabel":"string"},"street":{"type":"string","description":"Street name","example":"Main Street","isRequired":true,"uniqueKey":"customer.address.street","typeLabel":"string"},"number":{"type":"string","description":"Building number","example":"123","isRequired":true,"uniqueKey":"customer.address.number","typeLabel":"string"},"city":{"type":"string","description":"City name","example":"City","isRequired":true,"uniqueKey":"customer.address.city","typeLabel":"string"},"state":{"type":"string","description":"State/province code","example":"ST","isRequired":true,"uniqueKey":"customer.address.state","typeLabel":"string"},"complement":{"type":"string","description":"Additional address information","example":"Apt 4","uniqueKey":"customer.address.complement","typeLabel":"string"},"neighborhood":{"type":"string","description":"Neighborhood name","example":"Downtown","uniqueKey":"customer.address.neighborhood","typeLabel":"string"}},"isRequired":true,"uniqueKey":"customer.address","typeLabel":"object"}},"isRequired":true,"uniqueKey":"customer","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"StandardLoan":{"title":"StandardLoan","value":{"proposal_id":"abc1234","reference_code":"ref01234","max_age":60,"discriminator":"John's transaction","final_amount":10,"customer":{"name":"John Doe","birth":"1970-01-01","email":"foo@bar.com","mobile_number":"11999999999","document":{"type":"CPF","number":"00000000000"},"address":{"zipcode":"12345678","street":"Main Street","number":"123","complement":"Apt 4","neighborhood":"Downtown","city":"City","state":"ST"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"fd3f42cb-8559-4b79-932b-9dbcaeb261f6":{"description":"Loan creation response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Principal loan amount","example":800,"uniqueKey":"oneOf.0.amount","typeLabel":"number"},"appliedRate":{"type":"number","description":"Applied rate","example":0,"uniqueKey":"oneOf.0.appliedRate","typeLabel":"number"},"chosen_term":{"type":"object","description":"Selected payment term details","uniqueKey":"oneOf.0.chosen_term","typeLabel":"object"},"creation":{"type":"string","description":"Loan creation date and time","uniqueKey":"oneOf.0.creation","typeLabel":"string"},"currency":{"type":"string","description":"Currency code","uniqueKey":"oneOf.0.currency","typeLabel":"string"},"discounts":{"type":"number","description":"Applied discounts","uniqueKey":"oneOf.0.discounts","typeLabel":"number"},"id":{"type":"number","description":"Internal loan ID","uniqueKey":"oneOf.0.id","typeLabel":"number"},"maxAge":{"type":"string","description":"Loan expiration date and time","uniqueKey":"oneOf.0.maxAge","typeLabel":"string"},"message":{"type":"string","description":"Response message","example":"success","uniqueKey":"oneOf.0.message","typeLabel":"string"},"referenceCode":{"type":"string","description":"Merchant reference code","uniqueKey":"oneOf.0.referenceCode","typeLabel":"string"},"shipping":{"type":"number","description":"Shipping costs if applicable","uniqueKey":"oneOf.0.shipping","typeLabel":"number"},"shopper":{"type":"object","description":"Customer information","uniqueKey":"oneOf.0.shopper","typeLabel":"object"},"situation":{"type":"string","description":"Loan status","example":"PENDING","uniqueKey":"oneOf.0.situation","typeLabel":"string"},"status":{"type":"number","description":"Response status code","example":0,"uniqueKey":"oneOf.0.status","typeLabel":"number"},"total":{"type":"number","description":"Total loan amount","uniqueKey":"oneOf.0.total","typeLabel":"number"},"type":{"type":"string","description":"Transaction type","example":"SALE","uniqueKey":"oneOf.0.type","typeLabel":"string"},"uuid":{"type":"string","description":"Unique loan identifier","uniqueKey":"oneOf.0.uuid","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","properties":{"status":{"type":"number","description":"Response status code","example":-1,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"message":{"type":"string","description":"Response message","example":"proposal not accept","uniqueKey":"oneOf.1.message","typeLabel":"string"},"proposalAccepted":{"type":"boolean","description":"Indicates if the proposal was accepted","example":false,"uniqueKey":"oneOf.1.proposalAccepted","typeLabel":"boolean"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Success response":{"title":"Success response","value":{"amount":800,"appliedRate":0,"chosen_term":{"amount":800,"final_amount":845.31,"interest_rate":7.17,"label":"03x","monthly_interest_rate":2.39,"quotas":281.77,"times":3},"creation":"2021-03-17 10:43:49","currency":"BRL","discounts":0,"id":43863,"maxAge":"2021-03-19 02:40:49","message":"success","referenceCode":"5077AXC","shipping":0,"shopper":{"bankDetails":{},"document":{"number":"00000000000","type":"CPF"},"email":"foo@bar.com","name":"JOHN DOE","phone":{"number":"+5511999999999","type":"MOBILE"}},"situation":"PENDING","status":0,"total":800,"type":"SALE","uuid":"d7113995-e683-35b6-bf4f-7846ebc63819"}},"Proposal not accepted":{"title":"Proposal not accepted","value":{"status":-1,"message":"proposal not accepted","proposalAccepted":false}}},"exampleType":"examples"}},"exampleType":"examples"},"f606caa3-86b6-48b2-99f6-930cff1cd259":{"description":"Validation errors","content":{"application/json":{"schema":{"type":"object","properties":{"errorCount":{"type":"number","description":"Number of validation errors","example":1,"uniqueKey":"errorCount","typeLabel":"number"},"errors":{"type":"array","description":"List of validation errors","items":{"type":"object","properties":{"field":{"type":"string","description":"Field with error","example":"terms","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Error message","example":"must be between 1 and 12","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"main_error_message":{"type":"string","description":"Primary error message","example":"must be between 1 and 12","uniqueKey":"main_error_message","typeLabel":"string"},"message":{"type":"string","description":"General error message","example":"validation failure","uniqueKey":"message","typeLabel":"string"},"status":{"type":"number","description":"Error status code","example":-1,"uniqueKey":"status","typeLabel":"number"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Invalid terms response":{"title":"Invalid terms response","value":{"status":-1,"message":"validation failure","errorCount":1,"errors":[{"field":"terms","message":"must be between 1 and 12"}],"main_error_message":"must be between 1 and 12"}},"Invalid proposal ID response":{"title":"Invalid proposal ID response","value":{"status":-1,"message":"validation failure","errorCount":1,"errors":[{"field":"invalid proposal id","message":"invalid proposal id"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"1eeb5257-1f22-413f-bc59-37ded7259aae":{"description":"Unauthorized access","content":{"application/json":{"schema":{"type":"object","properties":{"errorCount":{"type":"number","example":1,"uniqueKey":"errorCount","typeLabel":"number"},"errors":{"type":"array","items":{"type":"object","properties":{"error":{"type":"string","example":"Forbidden","uniqueKey":"errors.items.[INDEX].error","typeLabel":"string"},"message":{"type":"string","example":"Access Denied","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"example":[{"error":"Forbidden","message":"Access Denied"}],"uniqueKey":"errors","typeLabel":"object[]"},"message":{"type":"string","example":"field validation failure","uniqueKey":"message","typeLabel":"string"},"status":{"type":"number","example":-1,"uniqueKey":"status","typeLabel":"number"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Unauthorized access":{"title":"Unauthorized access","value":{"errorCount":1,"errors":[{"error":"Forbidden","message":"Access Denied"}],"message":"field validation failure","status":-1}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{},"servers":{"f2574027-ca15-4eff-9fc1-9afd9af507bb":{"url":"https://api.paymee.com.br"},"ec2f7f3d-e147-414d-b0ee-e43f2c22bcad":{"url":"https://apisandbox.paymee.com.br"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"paymee","siteName":"API PayMee 1.1","title":"Create a loan - API PayMee 1.1","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-12-04T23:12:19.031Z","originalFileLocation":"api-reference/checkouts/create.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=\"Creates a loan based on a previously approved proposal\">\u003cmeta data-mint-head name=\"application-name\" content=\"API PayMee 1.1\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paymee/1ESogplNxDgw14mS/_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/paymee/1ESogplNxDgw14mS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paymee/1ESogplNxDgw14mS/_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/paymee/1ESogplNxDgw14mS/_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/paymee/1ESogplNxDgw14mS/_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/paymee/1ESogplNxDgw14mS/_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/paymee/1ESogplNxDgw14mS/_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/paymee/1ESogplNxDgw14mS/_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/paymee/1ESogplNxDgw14mS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a loan - API PayMee 1.1\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a loan based on a previously approved proposal\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"API PayMee 1.1\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.paymee.com.br/api-reference/checkouts/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paymee.mintlify.app/_mintlify/api/og/v2?division=Loan\u0026amp;title=Create+a+loan\u0026amp;description=Creates+a+loan+based+on+a+previously+approved+proposal\u0026amp;theme=1f86a6fc19d33e0bb49e7d52\u0026amp;signature=54f10aa43450b82bf64efc174abf08ac89e2d674e24dfd78ac2cd5050572cd5a\">\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=\"Create a loan - API PayMee 1.1\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a loan based on a previously approved proposal\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paymee.mintlify.app/_mintlify/api/og/v2?division=Loan\u0026amp;title=Create+a+loan\u0026amp;description=Creates+a+loan+based+on+a+previously+approved+proposal\u0026amp;theme=1f86a6fc19d33e0bb49e7d52\u0026amp;signature=54f10aa43450b82bf64efc174abf08ac89e2d674e24dfd78ac2cd5050572cd5a\">\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/paymee/1ESogplNxDgw14mS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"API PayMee 1.1\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#E85A27\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.paymee.com.br/api-reference/checkouts/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/checkouts/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.paymee.com.br/#organization\",\"name\":\"API PayMee 1.1\",\"url\":\"https://developer.paymee.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://paymee-public-cnd.s3.us-west-2.amazonaws.com/cropped-paymee-logo-transparent-blue.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.paymee.com.br#website\",\"name\":\"API PayMee 1.1\",\"url\":\"https://developer.paymee.com.br\",\"publisher\":{\"@id\":\"https://developer.paymee.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.paymee.com.br/api-reference/checkouts/create#webpage\",\"url\":\"https://developer.paymee.com.br/api-reference/checkouts/create\",\"name\":\"Create a loan\",\"description\":\"Creates a loan based on a previously approved proposal\",\"dateModified\":\"2025-12-04T23:12:19.031Z\",\"isPartOf\":{\"@id\":\"https://developer.paymee.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://developer.paymee.com.br/api-reference/checkouts/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.paymee.com.br/api-reference/checkouts/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Loan\",\"item\":\"https://developer.paymee.com.br/api-reference/checkouts/simulation\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a loan\",\"item\":\"https://developer.paymee.com.br/api-reference/checkouts/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.paymee.com.br/api-reference/checkouts/create#apireference\",\"headline\":\"Create a loan\",\"name\":\"Create a loan\",\"description\":\"Creates a loan based on a previously approved proposal\",\"url\":\"https://developer.paymee.com.br/api-reference/checkouts/create\",\"mainEntityOfPage\":{\"@id\":\"https://developer.paymee.com.br/api-reference/checkouts/create#webpage\"},\"dateModified\":\"2025-12-04T23:12:19.031Z\",\"publisher\":{\"@id\":\"https://developer.paymee.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.paymee.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"API PayMee 1.1\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"API PayMee 1.1","nav":{"global":{"anchors":[{"anchor":"Help","icon":"book-open-cover","href":"https://paymee.com.br/ajuda/"}]},"tabs":[{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Overview","href":"/api-reference/introduction"},{"title":"Solution Features","href":"/api-reference/solution-features"},{"title":"Architecture","href":"/api-reference/architecture"},{"title":"Sandbox and Tools","href":"/api-reference/sandbox-tools"},{"title":"Webhook Notifications","href":"/api-reference/webhook"}]},{"group":"Checkout","pages":[{"openapi":"post /v1.1/checkout/transparent","title":"Semi-transparent PIX, boleto, BolePix, credit card and Open Banking checkout","href":"/api-reference/checkouts/semi-transparent-wire-transfer-pix-and-credit-card-and-openbanking-checkout"},{"openapi":"post /v1.1/checkout","title":"Redirect checkout","href":"/api-reference/checkouts/redirect-checkout"}]},{"group":"Split","pages":[{"title":"Split Payments","href":"/api-reference/split-payments"},{"openapi":"get /v1.1/split/recipients","title":"List split recipients","href":"/api-reference/split/list-split-recipients"},{"openapi":"get /v1.1/split/recipients/{recipientId}","title":"Get a split recipient","href":"/api-reference/split/get-split-recipient"}]},{"group":"Payouts","pages":[{"openapi":"post /v1.1/payout/create","title":"Individual payout request","href":"/api-reference/payouts/individual-payout-request"},{"openapi":"post /v1.1/payout/create/batch","title":"Batch payout request","href":"/api-reference/payouts/batch-payout-request"},{"openapi":"post /v1.1/payout/authorize/{tid}/{authorizationCode}","title":"Authorize payout","href":"/api-reference/payouts/authorize-payout"},{"openapi":"delete /v1.1/payout","title":"Cancel a payout","href":"/api-reference/payouts/cancel-a-payout"}]},{"group":"Loan","pages":[{"openapi":"post /v1.1/loans/simulation","title":"Simulation","description":"Create a loan simulation based on customer information and requested amount","href":"/api-reference/checkouts/simulation"},{"openapi":"post /v1.1/loans/create","title":"Create a loan","href":"/api-reference/checkouts/create"}]},{"group":"Transactions","pages":[{"openapi":"get /v1.1/transactions/{transactionUUID}","title":"Query a transaction","description":"Returns detailed information about a sale, payout or refund transaction. Split sales include a `split` block: the parent sale lists its recipient legs, and a recipient-side transaction describes the leg it received.","href":"/api-reference/query-a-transaction"},{"openapi":"get /v1.1/transactions","title":"Query transactions using filters","href":"/api-reference/query-transactions-using-filters"},{"openapi":"get /v1.1/transactions/pix/{transactionUUID}","title":"Get pix data from a sale","href":"/api-reference/get-pix-data-from-a-sale"},{"openapi":"put /v1.1/transactions/{saleUUID}/void","title":"Cancel a transaction","href":"/api-reference/cancel-a-transaction"}]},{"group":"Payment Methods","pages":[{"openapi":"get /v1.1/available_payment_methods","title":"Get available payment methods","href":"/api-reference/get-available-payment-methods"}]},{"group":"Financial","pages":[{"openapi":"get /v1.1/balance","title":"Query current balance","href":"/api-reference/query-current-balance"},{"openapi":"put /v1.1/transactions/{saleUUID}/refund","title":"Request a sale refund","href":"/api-reference/request-a-sale-refund"}]},{"group":"Webhooks and Callbacks","pages":[{"openapi":"get /v1.1/transactions/{transactionUUID}/webhook","title":"Query webhook requests","href":"/api-reference/query-a-webhook-requests"},{"openapi":"get /v1.1/transactions/{transactionUUID}/webhook/redeliver","title":"Request a webhook redeliver","href":"/api-reference/request-a-webhook-redeliver"}]},{"group":"Payer Information","pages":[{"openapi":"get /v1.1/transactions/{sale_uuid}/payment_info","title":"Get payer information","href":"/api-reference/get-payer-information"}]},{"group":"Pix Automatic (Recurrence)","pages":[{"title":"Variable Amount (Dynamic Pricing)","href":"/api-reference/pix-automatic-variable-amount"},{"openapi":"post /v1.1/checkout/pix-automatic","title":"Create Pix Automatic Recurrence","href":"/api-reference/create-pix-automatic-checkout"},{"openapi":"post /v1.1/pix-automatic/plans","title":"Create a recurrence plan","href":"/api-reference/create-plan"},{"openapi":"put /v1.1/pix-automatic/plans/{planId}","title":"Update Plan","href":"/api-reference/update-plan"},{"openapi":"get /v1.1/pix-automatic/plans","title":"List recurrence plans","href":"/api-reference/list-plans"},{"openapi":"get /v1.1/pix-automatic/plans/{planId}","title":"Get plan by ID","href":"/api-reference/get-plan-by-id"},{"openapi":"get /v1.1/pix-automatic/authorizations","title":"List authorizations","href":"/api-reference/list-authorizations"},{"openapi":"get /v1.1/pix-automatic/authorizations/{idRec}","title":"Get authorization by recurrence ID","href":"/api-reference/get-authorization-by-id"},{"openapi":"put /v1.1/pix-automatic/authorizations/{idRec}/cancel","title":"Cancel authorization","href":"/api-reference/cancel-authorization"},{"openapi":"get /v1.1/pix-automatic/scheduled-payments","title":"List scheduled payments","href":"/api-reference/list-scheduled-payments"},{"openapi":"get /v1.1/pix-automatic/scheduled-payments/{instructionId}","title":"Get scheduled payment by instruction ID","href":"/api-reference/get-scheduled-payment-by-id"},{"openapi":"put /v1.1/pix-automatic/scheduled-payments/{instructionId}/cancel","title":"Cancel scheduled payment","href":"/api-reference/cancel-scheduled-payment"},{"title":"Testing Pix Automatic in Sandbox","href":"/api-reference/test-pix-automatic-in-sandbox"}]}]}]},"basePath":"","title":"Create a loan - API PayMee 1.1","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-Bevw23-4.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}