{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FirstPromoter Docs","colors":{"primary":"#2497F3","light":"#42A5F5","dark":"#1A1C25"},"logo":{"light":"https://mintcdn.com/firstpromoter/Qml53iAwCwPGiKRZ/logo/light.svg?fit=max\u0026auto=format\u0026n=Qml53iAwCwPGiKRZ\u0026q=85\u0026s=17d35344b27497f795682da8932295c9","dark":"https://mintcdn.com/firstpromoter/Qml53iAwCwPGiKRZ/logo/dark.svg?fit=max\u0026auto=format\u0026n=Qml53iAwCwPGiKRZ\u0026q=85\u0026s=ef23e747176d9a87b5ddf122595793f8"},"favicon":"https://mintcdn.com/firstpromoter/rNk-Jdvp2vdjAvd9/favicon.png?fit=max\u0026auto=format\u0026n=rNk-Jdvp2vdjAvd9\u0026q=85\u0026s=7faf17e323609b0fef661b9a9fe49ebc","navbar":{"links":[{"href":"mailto:support@firstpromoter.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://login.firstpromoter.com/"}},"footer":{"socials":{"x":"https://x.com/firstpromoter","linkedin":"https://www.linkedin.com/company/first-promoter"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"firstpromoter","hasAudioNarration":false,"actualSubdomain":"firstpromoter","customDomains":["docs.firstpromoter.com"],"gitSource":{"type":"github","owner":"firstpromoter","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6aedb2dbad97e8452b1fe618","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Documentation","count":213},{"language":"default","tag":"API Reference","count":81},{"language":"default","tag":"Integration Options","count":41},{"language":"default","tag":"Promoters","count":25},{"language":"default","tag":"Platform","count":23},{"language":"default","tag":"Custom","count":9},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Reports","count":8},{"language":"default","tag":"Payouts","count":7},{"language":"default","tag":"Commissions","count":7}]},"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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference-v1/payouts-api/create","slug":"/api-reference-v1/payouts-api/create","pageMetadata":{"title":"Create a new payout","openapi":"openapi-payouts POST /create","description":"This call allows you to create a payout for a specific promoter for the entire unpaid amount.","href":"/api-reference-v1/payouts-api/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: \"This call allows you to create a payout for a specific promoter for the entire unpaid amount.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a new payout","openapi":"openapi-payouts POST /create","description":"This call allows you to create a payout for a specific promoter for the entire unpaid amount.","href":"/api-reference-v1/payouts-api/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firstpromoter/8ad42af542d542c7/downloadables/fpr-prox.js"],"openApiReferenceData":{"operation":{"description":"This call allows you to create a payout for a specific promoter for the entire unpaid amount.","parameters":["85c52328-607b-4fc2-81b2-16ec437bbb00","3496a82f-132d-4076-8a12-ab6e242e87fb","6e605ec0-9921-42fb-a761-09246403c56e","cb711879-17a2-46f3-b1d1-1a34df9552a2"],"responses":{"200":"5c0f3e4a-5c47-4004-b24d-10019aa44ac0","422":"0ddb0f35-fe6f-47d9-b3b7-fb3a7fb2c112"},"method":"post","type":"path","servers":["ad4ead3b-8a2d-4d2b-94af-0e2d2a4e4987"],"security":["40b02a76-f7c7-49ef-b3e3-7ef1a918ecde"],"path":"/create","baseUrlOptions":["https://firstpromoter.com/api/v1/payouts"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"85c52328-607b-4fc2-81b2-16ec437bbb00":{"name":"promoter_email","in":"query","required":true,"description":"`required if promoter_id is null` \n\n Email of the promoter","schema":{"type":"string","format":"email","isRequired":true,"description":"`required if promoter_id is null` \n\n Email of the promoter","uniqueKey":"","typeLabel":"string\u003cemail>"}},"3496a82f-132d-4076-8a12-ab6e242e87fb":{"name":"promoter_id","in":"query","description":"`required if promoter_email is null` \n\n Id of the promoter to assign the payout","schema":{"type":"string","description":"`required if promoter_email is null` \n\n Id of the promoter to assign the payout","uniqueKey":"","typeLabel":"string"}},"6e605ec0-9921-42fb-a761-09246403c56e":{"name":"status","in":"query","description":"The payout status","schema":{"type":"string","enum":["pending","processing","completed"],"description":"The payout status","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"cb711879-17a2-46f3-b1d1-1a34df9552a2":{"name":"campaign_id","in":"query","description":"For what campaign to create the payout. If it is null, we'll take the promoter's default","schema":{"type":"string","description":"For what campaign to create the payout. If it is null, we'll take the promoter's default","uniqueKey":"","typeLabel":"string"}}},"responses":{"5c0f3e4a-5c47-4004-b24d-10019aa44ac0":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","example":2710287,"uniqueKey":"id","typeLabel":"integer"},"status":{"type":"string","example":"pending","uniqueKey":"status","typeLabel":"string"},"amount":{"type":"integer","example":3000,"uniqueKey":"amount","typeLabel":"integer"},"date_paid":{"oneOf":[{"type":"string","format":"date-time","example":null,"uniqueKey":"date_paid.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":null,"uniqueKey":"date_paid.oneOf.1","typeLabel":"null"}],"uniqueKey":"date_paid","typeLabel":"string\u003cdate-time> | null"},"due_date":{"type":"string","format":"date-time","example":"2024-10-11T00:00:00.000Z","uniqueKey":"due_date","typeLabel":"string\u003cdate-time>"},"unit":{"type":"string","example":"cash","uniqueKey":"unit","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","example":"2024-09-12T14:02:53.135Z","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"has_issues":{"type":"boolean","example":false,"uniqueKey":"has_issues","typeLabel":"boolean"},"reward":{"oneOf":[{"type":"object","example":null,"uniqueKey":"reward.oneOf.0","typeLabel":"object"},{"type":"null","example":null,"uniqueKey":"reward.oneOf.1","typeLabel":"null"}],"uniqueKey":"reward","typeLabel":"object | null"},"promoter":{"type":"object","properties":{"id":{"type":"integer","example":8262622,"uniqueKey":"promoter.id","typeLabel":"integer"},"status":{"type":"string","example":"active","uniqueKey":"promoter.status","typeLabel":"string"},"cust_id":{"type":"string","example":"","uniqueKey":"promoter.cust_id","typeLabel":"string"},"email":{"type":"string","example":"test@promoter.com","uniqueKey":"promoter.email","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","example":"2024-05-27T17:43:38.935Z","uniqueKey":"promoter.created_at","typeLabel":"string\u003cdate-time>"},"temp_password":{"type":"string","example":"xsKyiS","uniqueKey":"promoter.temp_password","typeLabel":"string"},"default_promotion_id":{"type":"integer","example":9441115,"uniqueKey":"promoter.default_promotion_id","typeLabel":"integer"},"pref":{"type":"string","example":"w4wfj9q","uniqueKey":"promoter.pref","typeLabel":"string"},"default_ref_id":{"type":"string","example":"testxeak1xz1","uniqueKey":"promoter.default_ref_id","typeLabel":"string"},"note":{"type":"string","example":"This is a test promoter. You can use it to test the integration.","uniqueKey":"promoter.note","typeLabel":"string"},"w8_form_url":{"oneOf":[{"type":"string","example":null,"uniqueKey":"promoter.w8_form_url.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"promoter.w8_form_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"promoter.w8_form_url","typeLabel":"string | null"},"w9_form_url":{"oneOf":[{"type":"string","example":null,"uniqueKey":"promoter.w9_form_url.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"promoter.w9_form_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"promoter.w9_form_url","typeLabel":"string | null"},"parent_promoter_id":{"oneOf":[{"type":"integer","example":null,"uniqueKey":"promoter.parent_promoter_id.oneOf.0","typeLabel":"integer"},{"type":"null","example":null,"uniqueKey":"promoter.parent_promoter_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"promoter.parent_promoter_id","typeLabel":"integer | null"},"earnings_balance":{"type":"object","properties":{"cash":{"type":"integer","example":23000,"uniqueKey":"promoter.earnings_balance.cash","typeLabel":"integer"}},"uniqueKey":"promoter.earnings_balance","typeLabel":"object"},"current_balance":{"type":"object","properties":{"cash":{"type":"integer","example":23000,"uniqueKey":"promoter.current_balance.cash","typeLabel":"integer"}},"uniqueKey":"promoter.current_balance","typeLabel":"object"},"paid_balance":{"oneOf":[{"type":"object","example":null,"uniqueKey":"promoter.paid_balance.oneOf.0","typeLabel":"object"},{"type":"null","example":null,"uniqueKey":"promoter.paid_balance.oneOf.1","typeLabel":"null"}],"uniqueKey":"promoter.paid_balance","typeLabel":"object | null"},"auth_token":{"type":"string","example":"bFahsKx8v9_zL9sPTZCDH8JnQAbTeDpy","uniqueKey":"promoter.auth_token","typeLabel":"string"}},"uniqueKey":"promoter","typeLabel":"object"},"campaign":{"type":"object","properties":{"id":{"type":"integer","example":15161,"uniqueKey":"campaign.id","typeLabel":"integer"},"name":{"type":"string","example":"Test new campaign","uniqueKey":"campaign.name","typeLabel":"string"},"landing_url":{"type":"string","example":"http://testmax.maxwelladapoe1.com/","uniqueKey":"campaign.landing_url","typeLabel":"string"},"description":{"type":"string","example":"","uniqueKey":"campaign.description","typeLabel":"string"},"private":{"type":"boolean","example":false,"uniqueKey":"campaign.private","typeLabel":"boolean"},"color":{"type":"string","example":"#00bcd4","uniqueKey":"campaign.color","typeLabel":"string"},"default_webhook_url":{"type":"string","example":"","uniqueKey":"campaign.default_webhook_url","typeLabel":"string"},"auto_approve_rewards":{"type":"boolean","example":true,"uniqueKey":"campaign.auto_approve_rewards","typeLabel":"boolean"},"auto_approve_promoters":{"type":"boolean","example":true,"uniqueKey":"campaign.auto_approve_promoters","typeLabel":"boolean"}},"uniqueKey":"campaign","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":2710287,"status":"pending","amount":3000,"date_paid":null,"due_date":"2024-10-11T00:00:00.000Z","unit":"cash","created_at":"2024-09-12T14:02:53.135Z","has_issues":false,"reward":null,"promoter":{"id":8262622,"status":"active","cust_id":"","email":"test@promoter.com","created_at":"2024-05-27T17:43:38.935Z","temp_password":"xsKyiS","default_promotion_id":9441115,"pref":"w4wfj9q","default_ref_id":"testxeak1xz1","note":"This is a test promoter. You can use it to test the integration.","w8_form_url":null,"w9_form_url":null,"parent_promoter_id":null,"earnings_balance":{"cash":23000},"current_balance":{"cash":23000},"paid_balance":null,"auth_token":"bFahsKx8v9_zL9sPTZCDH8JnQAbTeDpy"},"campaign":{"id":15161,"name":"Test new campaign","landing_url":"http://testmax.maxwelladapoe1.com/","description":"","private":false,"color":"#00bcd4","default_webhook_url":"","auto_approve_rewards":true,"auto_approve_promoters":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"0ddb0f35-fe6f-47d9-b3b7-fb3a7fb2c112":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"You need to pass either promoter_email or promoter_id.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"You need to pass either promoter_email or promoter_id."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"40b02a76-f7c7-49ef-b3e3-7ef1a918ecde":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]}}},"servers":{"ad4ead3b-8a2d-4d2b-94af-0e2d2a4e4987":{"url":"https://firstpromoter.com/api/v1/payouts"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"X-API-KEY"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference-v1/payouts-api/openapi-payouts.json"},"subdomain":"firstpromoter","siteName":"FirstPromoter Docs","title":"Create a new payout - FirstPromoter Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference-v2/api-admin/payouts/get-all-payouts","matchLevel":2},"v1":{"href":"/api-reference-v1/payouts-api/create","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2025-08-07T12:33:18.632Z","originalFileLocation":"api-reference-v1/payouts-api/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=\"This call allows you to create a payout for a specific promoter for the entire unpaid amount.\">\u003cmeta data-mint-head name=\"application-name\" content=\"FirstPromoter Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a new payout - FirstPromoter Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"This call allows you to create a payout for a specific promoter for the entire unpaid amount.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FirstPromoter Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firstpromoter.mintlify.site/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Create+a+new+payout\u0026amp;description=This+call+allows+you+to+create+a+payout+for+a+specific+promoter+for+the+entire+unpaid+amount.\u0026amp;theme=6c5c6938239eba73fb25a5bd\u0026amp;signature=37e2080ba441a219d6fd677f1ac10dbe63da127475db031c9da18c7777d175d6\">\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 new payout - FirstPromoter Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This call allows you to create a payout for a specific promoter for the entire unpaid amount.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firstpromoter.mintlify.site/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Create+a+new+payout\u0026amp;description=This+call+allows+you+to+create+a+payout+for+a+specific+promoter+for+the+entire+unpaid+amount.\u0026amp;theme=6c5c6938239eba73fb25a5bd\u0026amp;signature=37e2080ba441a219d6fd677f1ac10dbe63da127475db031c9da18c7777d175d6\">\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/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FirstPromoter Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2497F3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/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-v1/payouts-api/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.firstpromoter.com/#organization\",\"name\":\"FirstPromoter Docs\",\"url\":\"https://docs.firstpromoter.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/firstpromoter/Qml53iAwCwPGiKRZ/logo/light.svg?fit=max\u0026auto=format\u0026n=Qml53iAwCwPGiKRZ\u0026q=85\u0026s=17d35344b27497f795682da8932295c9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.firstpromoter.com#website\",\"name\":\"FirstPromoter Docs\",\"url\":\"https://docs.firstpromoter.com\",\"publisher\":{\"@id\":\"https://docs.firstpromoter.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/create#webpage\",\"url\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/create\",\"name\":\"Create a new payout\",\"description\":\"This call allows you to create a payout for a specific promoter for the entire unpaid amount.\",\"dateModified\":\"2025-08-07T12:33:18.632Z\",\"isPartOf\":{\"@id\":\"https://docs.firstpromoter.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payouts\",\"item\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a new payout\",\"item\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/create#apireference\",\"headline\":\"Create a new payout\",\"name\":\"Create a new payout\",\"description\":\"This call allows you to create a payout for a specific promoter for the entire unpaid amount.\",\"url\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/create#webpage\"},\"dateModified\":\"2025-08-07T12:33:18.632Z\",\"publisher\":{\"@id\":\"https://docs.firstpromoter.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.firstpromoter.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FirstPromoter Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"FirstPromoter Docs","nav":{"global":null,"versions":[{"version":"v2","pages":[{"title":"v2","href":"/api-reference-v2/api-admin/payouts/get-all-payouts"}]},{"version":"v1","anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference-v1/introduction"},{"title":"Authentication","href":"/api-reference-v1/authentication"}]},{"group":"Tracking","pages":[{"title":"Tracking leads and sign-ups","openapi":"openapi-tracking POST /signup","href":"/api-reference-v1/tracking-api/leads-and-signups"},{"title":"Tracking sales and commissions","openapi":"openapi-tracking POST /sale","href":"/api-reference-v1/tracking-api/sales"},{"title":"Tracking refunds and negative commissions","openapi":"openapi-tracking POST /refund","href":"/api-reference-v1/tracking-api/refund"},{"title":"Tracking cancellations","openapi":"openapi-tracking POST /cancellation","href":"/api-reference-v1/tracking-api/cancellation"}]},{"group":"Leads","pages":[{"title":"Modify existing lead/customer","openapi":"openapi-leads PUT /update","href":"/api-reference-v1/leads-api/update"},{"title":"List leads/customers","openapi":"openapi-leads GET /list","href":"/api-reference-v1/leads-api/list"},{"title":"Show leads and customers details","openapi":"openapi-leads GET /show","href":"/api-reference-v1/leads-api/show"},{"title":"Delete lead/customer","openapi":"openapi-leads DELETE /delete","href":"/api-reference-v1/leads-api/delete"}]},{"group":"Promoters","pages":[{"title":"Create a new promoter","openapi":"openapi-promoters POST /create","href":"/api-reference-v1/promoters-api/create"},{"title":"Modify existing promoter","openapi":"openapi-promoters PUT /update","href":"/api-reference-v1/promoters-api/update"},{"title":"List promoters","openapi":"openapi-promoters GET /list","href":"/api-reference-v1/promoters-api/list"},{"title":"Show promoter details and balance","openapi":"openapi-promoters GET /show","href":"/api-reference-v1/promoters-api/show-details"},{"title":"Move/switch a promoter from one campaign to another","openapi":"openapi-promoters POST /move_to_campaign","href":"/api-reference-v1/promoters-api/move-to-campaign"},{"title":"Add a promoter to a campaign","openapi":"openapi-promoters POST /add_to_campaign","href":"/api-reference-v1/promoters-api/add-to-campaign"},{"title":"Reset promoter's authentication token","openapi":"openapi-promoters PUT /refresh_token","href":"/api-reference-v1/promoters-api/refresh-token"},{"title":"Delete a promoter","openapi":"openapi-promoters DELETE /delete","href":"/api-reference-v1/promoters-api/delete"}]},{"group":"Rewards","pages":[{"title":"Create new reward","openapi":"openapi-rewards POST /create","href":"/api-reference-v1/rewards-api/create"},{"title":"List rewards and commissions","openapi":"openapi-rewards GET /list","href":"/api-reference-v1/rewards-api/list"},{"title":"Update a reward or commission","openapi":"openapi-rewards PUT /update","href":"/api-reference-v1/rewards-api/update"}]},{"group":"Payouts","pages":[{"title":"List payouts","openapi":"openapi-payouts GET /list","description":"With this endpoint, you can list all payouts for a promoter, a campaign, or the entire account using the API. \u003cTip>**HTTP Request** \u003cbr/>\u003cbr/> `GET https://firstpromoter.com/api/v1/payouts/list`\u003c/Tip>","href":"/api-reference-v1/payouts-api/list"},{"title":"Create a new payout","openapi":"openapi-payouts POST /create","href":"/api-reference-v1/payouts-api/create"},{"title":"Change payouts status","openapi":"openapi-payouts PUT /update","description":"This call allows you to change the status of the payout. For example, you can mark the payout as completed once it has been paid.","href":"/api-reference-v1/payouts-api/update"}]},{"group":"Reports","pages":[{"title":"Overview reports","openapi":"openapi-reports GET /overview","href":"/api-reference-v1/reports-api/overview"},{"title":"Campaign reports","openapi":"openapi-reports GET /campaigns","href":"/api-reference-v1/reports-api/campaign"},{"title":"Promoter reports","openapi":"openapi-reports GET /promoters","href":"/api-reference-v1/reports-api/promoter"}]}]}]},{"anchor":"API Reference","icon":"webhook","href":"https://docs.firstpromoter.com/api-reference-v1/introduction"},{"anchor":"Help Center","icon":"square-question","href":"https://help.firstpromoter.com/en/"}]}]},"basePath":"","title":"Create a new payout - FirstPromoter Docs","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}