{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}
Payout Schedules
Edit (re-authorize) a scheduled payout
Replaces the recipient list / amounts (new hire, resignation, raise) WITHOUT recreating the schedule — the cadence, day-of-month and nextRunAt timing are preserved. Every edit re-authorizes: it re-validates the payload + per-run cap, sanctions-screens every recipient in the new payload, re-verifies the transaction PIN on the dashboard path (api-key exempt), and re-stamps authorizedAt/By. Only ACTIVE/PAUSED schedules are editable; changing the cadence/timing still requires recreating the schedule.
Optional per-currency caps for locally-denominated runs. A currency listed here is checked against the run total in that currency and is immune to FX movement; every other currency still falls under maxRunAmountUsd. Omit for USD-only capping (the existing behaviour).
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Axra","colors":{"primary":"#7C3AED","light":"#A78BFA","dark":"#5B21B6"},"logo":{"light":"https://mintcdn.com/axra/Wy1MdLLmzpX7ePSr/logo.png?fit=max\u0026auto=format\u0026n=Wy1MdLLmzpX7ePSr\u0026q=85\u0026s=002e9d7a645844c1cebffb6f5549553e","dark":"https://mintcdn.com/axra/Wy1MdLLmzpX7ePSr/logo.png?fit=max\u0026auto=format\u0026n=Wy1MdLLmzpX7ePSr\u0026q=85\u0026s=002e9d7a645844c1cebffb6f5549553e"},"favicon":"https://mintcdn.com/axra/Wy1MdLLmzpX7ePSr/logo.png?fit=max\u0026auto=format\u0026n=Wy1MdLLmzpX7ePSr\u0026q=85\u0026s=002e9d7a645844c1cebffb6f5549553e","api":{},"appearance":{"default":"light"},"navbar":{"links":[{"href":"https://app.useaxra.com","label":"Dashboard"},{"href":"mailto:support@useaxra.com","label":"Support"}],"primary":{"type":"button","label":"Get API Keys","href":"https://app.useaxra.com/register"}},"footer":{"socials":{"website":"https://useaxra.com","github":"https://github.com/GoFree-Inc"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"axra","hasAudioNarration":false,"actualSubdomain":"axra","customDomains":["docs.useaxra.com"],"gitSource":{"type":"github","owner":"gofree-inc","repo":"axra-monorepo","deployBranch":"staging","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6acfbd22a9e2199f1398bf11","collectionId":"dbf57f3b-ad8e-4e1a-a4a8-1854f2d43508","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acfbd22a9e2199f1398bf11"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6acfbd22a9e2199f1398bf11","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":103},{"language":"default","tag":"Developer Platform","count":24},{"language":"default","tag":"Webhooks","count":19},{"language":"default","tag":"Payments","count":19},{"language":"default","tag":"Fraud","count":8},{"language":"default","tag":"Disputes","count":7},{"language":"default","tag":"Payouts","count":7},{"language":"default","tag":"Treasury — Wallets","count":7},{"language":"default","tag":"Get Started","count":6},{"language":"default","tag":"Treasury","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"src/app/(docs)/globals.css","content":"@import \"tailwindcss\";"}],"page":{"pagePath":"api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout","slug":"/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout","pageMetadata":{"title":"Edit (re-authorize) a scheduled payout","description":"Replaces the recipient list / amounts (new hire, resignation, raise) WITHOUT recreating the schedule — the cadence, day-of-month and nextRunAt timing are preserved. Every edit re-authorizes: it re-validates the payload + per-run cap, sanctions-screens every recipient in the new payload, re-verifies the transaction PIN on the dashboard path (api-key exempt), and re-stamps authorizedAt/By. Only ACTIVE/PAUSED schedules are editable; changing the cadence/timing still requires recreating the schedule.","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/business/payouts/schedules/{id}","href":"/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout","autogeneratedByOpenApi":true},"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: \"Replaces the recipient list / amounts (new hire, resignation, raise) WITHOUT recreating the schedule — the cadence, day-of-month and nextRunAt timing are preserved. Every edit re-authorizes: it re-validates the payload + per-run cap, sanctions-screens every recipient in the new payload, re-verifies the transaction PIN on the dashboard path (api-key exempt), and re-stamps authorizedAt/By. Only ACTIVE/PAUSED schedules are editable; changing the cadence/timing still requires recreating the schedule.\"\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":"Edit (re-authorize) a scheduled payout","description":"Replaces the recipient list / amounts (new hire, resignation, raise) WITHOUT recreating the schedule — the cadence, day-of-month and nextRunAt timing are preserved. Every edit re-authorizes: it re-validates the payload + per-run cap, sanctions-screens every recipient in the new payload, re-verifies the transaction PIN on the dashboard path (api-key exempt), and re-stamps authorizedAt/By. Only ACTIVE/PAUSED schedules are editable; changing the cadence/timing still requires recreating the schedule.","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/business/payouts/schedules/{id}","href":"/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Replaces the recipient list / amounts (new hire, resignation, raise) WITHOUT recreating the schedule — the cadence, day-of-month and nextRunAt timing are preserved. Every edit re-authorizes: it re-validates the payload + per-run cap, sanctions-screens every recipient in the new payload, re-verifies the transaction PIN on the dashboard path (api-key exempt), and re-stamps authorizedAt/By. Only ACTIVE/PAUSED schedules are editable; changing the cadence/timing still requires recreating the schedule.","operationId":"SchedulePayoutsController_edit","parameters":["e903e1ef-fff7-4e27-b2eb-f057ace5f151","fa27a76d-047f-411a-a98a-5e02d3e8d749","0b5f3f8c-d918-4cc9-ab04-e0591fad8f39"],"requestBody":"333faa44-2dbf-4e8a-b655-c2dd019eb2cb","responses":{"200":"bf0e65e6-eda8-4dad-bbc8-472656af6671","400":"d5b6518c-7cc5-46bf-9c53-2dfd176459d9","401":"ff66bb0f-382a-449c-a756-49055812b289","403":"e8b6d7b1-9ca6-4987-b64c-120bcfc565a1","404":"4b7148aa-2453-480a-8a13-00f4c2b32c29","409":"08c18bbe-0ad7-4221-a2f8-f8e5b57565ad","422":"d351becf-5fe9-4e05-a17e-30284bb84352","429":"1ccf531d-9e58-4455-a7f3-2864b8666f33","500":"0dcd364e-3d40-43d8-b3a0-933f70a67c3d"},"security":["efad7d94-81c2-4ef6-b186-b6c0acb517a8"],"summary":"Edit (re-authorize) a scheduled payout","tags":["Payout Schedules"],"method":"put","type":"path","servers":["aa8b70a5-ddb0-4fac-b36f-7a7d764d0b78","1fb2589e-298e-4946-a657-368a3738a764","c466800f-083d-4481-b80b-99bcb828b176"],"path":"/api/v1/business/payouts/schedules/{id}","baseUrlOptions":["http://localhost:3001","https://staging-api.useaxra.com","https://api.useaxra.com"],"title":"Edit (re-authorize) a scheduled payout","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e903e1ef-fff7-4e27-b2eb-f057ace5f151":{"name":"X-Axra-Business-Id","in":"header","description":"Active business context","required":false,"schema":{"type":"string","isRequired":false,"description":"Active business context","uniqueKey":"","typeLabel":"string"}},"fa27a76d-047f-411a-a98a-5e02d3e8d749":{"name":"x-api-key","in":"header","description":"Merchant API key (alternative to dashboard JWT)","required":false,"schema":{"type":"string","isRequired":false,"description":"Merchant API key (alternative to dashboard JWT)","uniqueKey":"","typeLabel":"string"}},"0b5f3f8c-d918-4cc9-ab04-e0591fad8f39":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"payloadKind":{"type":"string","enum":["SINGLE","BATCH"],"description":"SINGLE | BATCH.","isRequired":true,"uniqueKey":"payloadKind","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"The replacement frozen payout spec (re-screened on edit).","required":["kind","items"],"properties":{"kind":{"type":"string","enum":["SINGLE","BATCH"],"description":"SINGLE | BATCH discriminator.","isRequired":true,"uniqueKey":"payload.kind","typeLabel":"enum\u003cstring>"},"items":{"minItems":1,"maxItems":5000,"description":"Payout specs. SINGLE must carry exactly one item; BATCH carries up to BATCH_MAX_ITEMS.","type":"array","items":{"type":"object","properties":{"country":{"type":"string","enum":["NG","KE","ZA","TZ","UG","RW","MW","ZM","BW","CM","BJ","BF","CD","CI","GA","ML","CG","SN","TG"],"description":"ISO 3166-1 alpha-2 corridor country (must match the recipient country).","isRequired":true,"uniqueKey":"payload.\\items.items.[INDEX].country","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","description":"Local destination currency for the corridor (e.g. NGN, KES).","isRequired":true,"uniqueKey":"payload.\\items.items.[INDEX].currency","typeLabel":"string"},"recipientId":{"type":"string","description":"Saved recipient id. Provide exactly one of recipientId or inline `recipient`.","uniqueKey":"payload.\\items.items.[INDEX].recipientId","typeLabel":"string"},"recipient":{"type":"object","description":"Inline recipient details (mutually exclusive with recipientId). Sanctions-screened and saved to your recipient book at schedule creation.","required":["label","rail","details"],"properties":{"label":{"type":"string","maxLength":120,"isRequired":true,"uniqueKey":"payload.\\items.items.[INDEX].recipient.label","typeLabel":"string"},"rail":{"type":"string","enum":["CRYPTO","ACH","WIRE","SEPA","SWIFT","LOCAL_BANK","LOCAL_MOMO"],"isRequired":true,"uniqueKey":"payload.\\items.items.[INDEX].recipient.rail","typeLabel":"enum\u003cstring>"},"details":{"type":"object","description":"Rail-specific destination (shape depends on rail)","isRequired":true,"uniqueKey":"payload.\\items.items.[INDEX].recipient.details","typeLabel":"object"}},"uniqueKey":"payload.\\items.items.[INDEX].recipient","typeLabel":"object"},"srcAmount":{"type":"string","pattern":"/^[0-9]+(\\.[0-9]{1,8})?$/","example":"50.00","description":"Source amount in USDC (the principal to convert/deliver). Provide srcAmount OR dstAmount.","uniqueKey":"payload.\\items.items.[INDEX].srcAmount","typeLabel":"string"},"dstAmount":{"type":"string","pattern":"/^[0-9]+(\\.[0-9]{1,8})?$/","example":"50000","description":"Destination amount in the local currency. Provide srcAmount OR dstAmount.","uniqueKey":"payload.\\items.items.[INDEX].dstAmount","typeLabel":"string"},"reference":{"type":"string","minLength":0,"maxLength":140,"description":"Free-form per-item reference (e.g. \"March salary\").","uniqueKey":"payload.\\items.items.[INDEX].reference","typeLabel":"string"}},"required":["country","currency"],"uniqueKey":"payload.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payload.\\items","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"payload","typeLabel":"object"},"name":{"type":"string","minLength":1,"maxLength":120,"description":"New label (rename). Omit to keep the current name.","uniqueKey":"name","typeLabel":"string"},"maxRunAmountUsd":{"type":"number","minimum":0,"example":50000,"description":"Per-run USD cap (compliance). Defaults to SCHEDULE_RUN_USD_DEFAULT ($50k); rejected if above the SCHEDULE_RUN_USD_CEILING admin cap ($250k).","uniqueKey":"maxRunAmountUsd","typeLabel":"number"},"pin":{"type":"string","minLength":4,"maxLength":6,"description":"Transaction PIN, required on the dashboard path to re-authorize the edit (verified server-side). Not required on the api-key path.","uniqueKey":"pin","typeLabel":"string"},"maxRunLocalCaps":{"maxItems":20,"description":"Optional per-currency caps for locally-denominated runs. A currency listed here is checked against the run total in that currency and is immune to FX movement; every other currency still falls under maxRunAmountUsd. Omit for USD-only capping (the existing behaviour).","type":"array","items":{"type":"object","properties":{"currency":{"type":"string","minLength":3,"maxLength":8,"example":"NGN","description":"Destination currency this cap applies to.","isRequired":true,"uniqueKey":"maxRunLocalCaps.items.[INDEX].currency","typeLabel":"string"},"amount":{"type":"string","pattern":"/^[0-9]+(\\.[0-9]{1,8})?$/","example":"20000000","description":"Maximum total destination amount per run in `currency`. Compared against the sum of the run's destination amounts in that currency — never converted, so it does not move with FX.","isRequired":true,"uniqueKey":"maxRunLocalCaps.items.[INDEX].amount","typeLabel":"string"}},"required":["currency","amount"],"uniqueKey":"maxRunLocalCaps.items.[INDEX]","typeLabel":"object"},"uniqueKey":"maxRunLocalCaps","typeLabel":"object[]"}},"required":["payloadKind","payload"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payload":{"items":[{"currency":"\u003cstring>","recipientId":"\u003cstring>","srcAmount":"50.00","dstAmount":"50000","reference":"\u003cstring>"}]},"name":"\u003cstring>","maxRunAmountUsd":50000,"pin":"\u003cstring>","maxRunLocalCaps":[{"currency":"NGN","amount":"20000000"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"bf0e65e6-eda8-4dad-bbc8-472656af6671":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"businessId":{"type":"string","isRequired":true,"uniqueKey":"data.businessId","typeLabel":"string"},"name":{"type":"string","description":"Human label, e.g. \"Monthly payroll\".","isRequired":true,"uniqueKey":"data.name","typeLabel":"string"},"cadence":{"type":"string","enum":["ONCE","WEEKLY","BIWEEKLY","MONTHLY"],"isRequired":true,"uniqueKey":"data.cadence","typeLabel":"enum\u003cstring>"},"payloadKind":{"type":"string","enum":["SINGLE","BATCH"],"isRequired":true,"uniqueKey":"data.payloadKind","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["ACTIVE","PAUSED","COMPLETED","CANCELLED"],"isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"itemCount":{"type":"number","description":"Number of payout specs in the frozen payload.","isRequired":true,"uniqueKey":"data.itemCount","typeLabel":"number"},"nextRunAt":{"type":"string","description":"When the next run fires (ISO-8601).","isRequired":true,"uniqueKey":"data.nextRunAt","typeLabel":"string"},"runCount":{"type":"number","description":"How many times this schedule has run.","isRequired":true,"uniqueKey":"data.runCount","typeLabel":"number"},"maxRunAmountUsd":{"type":"string","description":"Per-run USD cap (compliance).","isRequired":true,"uniqueKey":"data.maxRunAmountUsd","typeLabel":"string"},"authorizedAt":{"type":"string","description":"When PIN + screening were completed at creation (ISO-8601).","isRequired":true,"uniqueKey":"data.authorizedAt","typeLabel":"string"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","isRequired":true,"uniqueKey":"data.updatedAt","typeLabel":"string"},"dayOfMonth":{"oneOf":[{"type":"number","description":"MONTHLY day-of-month (1–28). Null for other cadences.","uniqueKey":"data.dayOfMonth.oneOf.0","typeLabel":"number"},{"type":"null","description":"MONTHLY day-of-month (1–28). Null for other cadences.","uniqueKey":"data.dayOfMonth.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.dayOfMonth","typeLabel":"number | null"},"lastRunAt":{"oneOf":[{"type":"string","description":"When the last run fired (ISO-8601).","uniqueKey":"data.lastRunAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the last run fired (ISO-8601).","uniqueKey":"data.lastRunAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.lastRunAt","typeLabel":"string | null"},"endAt":{"oneOf":[{"type":"string","description":"Optional natural end (ISO-8601).","uniqueKey":"data.endAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional natural end (ISO-8601).","uniqueKey":"data.endAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.endAt","typeLabel":"string | null"},"maxRunLocalCaps":{"oneOf":[{"description":"Per-currency run caps, or null for USD-only capping. A currency listed here is checked against the run total in that currency, so it does not breach on FX movement alone.","type":"array","items":{"type":"object","properties":{"currency":{"type":"string","minLength":3,"maxLength":8,"example":"NGN","description":"Destination currency this cap applies to.","isRequired":true,"uniqueKey":"data.maxRunLocalCaps.oneOf.0.items.[INDEX].currency","typeLabel":"string"},"amount":{"type":"string","pattern":"/^[0-9]+(\\.[0-9]{1,8})?$/","example":"20000000","description":"Maximum total destination amount per run in `currency`. Compared against the sum of the run's destination amounts in that currency — never converted, so it does not move with FX.","isRequired":true,"uniqueKey":"data.maxRunLocalCaps.oneOf.0.items.[INDEX].amount","typeLabel":"string"}},"required":["currency","amount"],"uniqueKey":"data.maxRunLocalCaps.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.maxRunLocalCaps.oneOf.0","typeLabel":"object[]"},{"description":"Per-currency run caps, or null for USD-only capping. A currency listed here is checked against the run total in that currency, so it does not breach on FX movement alone.","type":"null","items":{"type":"object","properties":{"currency":{"type":"string","minLength":3,"maxLength":8,"example":"NGN","description":"Destination currency this cap applies to."},"amount":{"type":"string","pattern":"/^[0-9]+(\\.[0-9]{1,8})?$/","example":"20000000","description":"Maximum total destination amount per run in `currency`. Compared against the sum of the run's destination amounts in that currency — never converted, so it does not move with FX."}},"required":["currency","amount"]},"uniqueKey":"data.maxRunLocalCaps.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.maxRunLocalCaps","typeLabel":"object[] | null"}},"required":["id","businessId","name","cadence","payloadKind","status","itemCount","nextRunAt","runCount","maxRunAmountUsd","authorizedAt","createdAt","updatedAt"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["success","data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"id":"\u003cstring>","businessId":"\u003cstring>","name":"\u003cstring>","cadence":"ONCE","payloadKind":"SINGLE","status":"ACTIVE","itemCount":123,"nextRunAt":"\u003cstring>","runCount":123,"maxRunAmountUsd":"\u003cstring>","authorizedAt":"\u003cstring>","createdAt":"\u003cstring>","updatedAt":"\u003cstring>","dayOfMonth":123,"lastRunAt":"\u003cstring>","endAt":"\u003cstring>","maxRunLocalCaps":[{"currency":"NGN","amount":"20000000"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"d5b6518c-7cc5-46bf-9c53-2dfd176459d9":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","example":"VALIDATION_ERROR","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"email must be an email","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"statusCode":{"type":"number","example":400,"isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"number"},"errors":{"type":"object","description":"Optional per-field validation messages (when present on the source exception)","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"error.errors","typeLabel":"object"}},"required":["code","message","statusCode"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"email must be an email","statusCode":400,"errors":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"ff66bb0f-382a-449c-a756-49055812b289":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","example":"VALIDATION_ERROR","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"email must be an email","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"statusCode":{"type":"number","example":400,"isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"number"},"errors":{"type":"object","description":"Optional per-field validation messages (when present on the source exception)","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"error.errors","typeLabel":"object"}},"required":["code","message","statusCode"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"email must be an email","statusCode":400,"errors":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"e8b6d7b1-9ca6-4987-b64c-120bcfc565a1":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","example":"VALIDATION_ERROR","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"email must be an email","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"statusCode":{"type":"number","example":400,"isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"number"},"errors":{"type":"object","description":"Optional per-field validation messages (when present on the source exception)","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"error.errors","typeLabel":"object"}},"required":["code","message","statusCode"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"email must be an email","statusCode":400,"errors":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"4b7148aa-2453-480a-8a13-00f4c2b32c29":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","example":"VALIDATION_ERROR","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"email must be an email","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"statusCode":{"type":"number","example":400,"isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"number"},"errors":{"type":"object","description":"Optional per-field validation messages (when present on the source exception)","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"error.errors","typeLabel":"object"}},"required":["code","message","statusCode"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"email must be an email","statusCode":400,"errors":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"08c18bbe-0ad7-4221-a2f8-f8e5b57565ad":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","example":"VALIDATION_ERROR","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"email must be an email","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"statusCode":{"type":"number","example":400,"isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"number"},"errors":{"type":"object","description":"Optional per-field validation messages (when present on the source exception)","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"error.errors","typeLabel":"object"}},"required":["code","message","statusCode"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"email must be an email","statusCode":400,"errors":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"d351becf-5fe9-4e05-a17e-30284bb84352":{"description":"Unprocessable","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","example":"VALIDATION_ERROR","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"email must be an email","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"statusCode":{"type":"number","example":400,"isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"number"},"errors":{"type":"object","description":"Optional per-field validation messages (when present on the source exception)","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"error.errors","typeLabel":"object"}},"required":["code","message","statusCode"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"email must be an email","statusCode":400,"errors":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"1ccf531d-9e58-4455-a7f3-2864b8666f33":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","example":"VALIDATION_ERROR","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"email must be an email","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"statusCode":{"type":"number","example":400,"isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"number"},"errors":{"type":"object","description":"Optional per-field validation messages (when present on the source exception)","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"error.errors","typeLabel":"object"}},"required":["code","message","statusCode"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"email must be an email","statusCode":400,"errors":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"0dcd364e-3d40-43d8-b3a0-933f70a67c3d":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","example":"VALIDATION_ERROR","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"email must be an email","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"statusCode":{"type":"number","example":400,"isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"number"},"errors":{"type":"object","description":"Optional per-field validation messages (when present on the source exception)","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"error.errors","typeLabel":"object"}},"required":["code","message","statusCode"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"email must be an email","statusCode":400,"errors":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"efad7d94-81c2-4ef6-b186-b6c0acb517a8":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[],"schemeName":"bearer"}}},"servers":{"aa8b70a5-ddb0-4fac-b36f-7a7d764d0b78":{"url":"http://localhost:3001","description":"Local development"},"1fb2589e-298e-4946-a657-368a3738a764":{"url":"https://staging-api.useaxra.com","description":"Staging"},"c466800f-083d-4481-b80b-99bcb828b176":{"url":"https://api.useaxra.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"axra","siteName":"Axra","title":"Edit (re-authorize) a scheduled payout - Axra","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T17:34:38.884Z","originalFileLocation":"api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout.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=\"light\"}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=\"Replaces the recipient list / amounts (new hire, resignation, raise) WITHOUT recreating the schedule — the cadence, day-of-month and nextRunAt timing are preserved. Every edit re-authorizes: it re-validates the payload + per-run cap, sanctions-screens every recipient in the new payload, re-verifies the transaction PIN on the dashboard path (api-key exempt), and re-stamps authorizedAt/By. Only ACTIVE/PAUSED schedules are editable; changing the cadence/timing still requires recreating the schedule.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Axra\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/axra/5n58I_XtfnPFe0cK/_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/axra/5n58I_XtfnPFe0cK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/axra/5n58I_XtfnPFe0cK/_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/axra/5n58I_XtfnPFe0cK/_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/axra/5n58I_XtfnPFe0cK/_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/axra/5n58I_XtfnPFe0cK/_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/axra/5n58I_XtfnPFe0cK/_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/axra/5n58I_XtfnPFe0cK/_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/axra/5n58I_XtfnPFe0cK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Edit (re-authorize) a scheduled payout - Axra\">\u003cmeta data-mint-head property=\"og:description\" content=\"Replaces the recipient list / amounts (new hire, resignation, raise) WITHOUT recreating the schedule — the cadence, day-of-month and nextRunAt timing are preserved. Every edit re-authorizes: it re-validates the payload + per-run cap, sanctions-screens every recipient in the new payload, re-verifies the transaction PIN on the dashboard path (api-key exempt), and re-stamps authorizedAt/By. Only ACTIVE/PAUSED schedules are editable; changing the cadence/timing still requires recreating the schedule.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Axra\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.useaxra.com/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://axra.mintlify.app/_mintlify/api/og/v2?division=Payout+Schedules\u0026amp;title=Edit+%28re-authorize%29+a+scheduled+payout\u0026amp;description=Replaces+the+recipient+list+%2F+amounts+%28new+hire%2C+resignation%2C+raise%29+WITHOUT+recreating+the+schedule+%E2%80%94+the+cadence%2C+day-of-month+and+nextRunAt+timing+are+preser\u0026amp;theme=a3cbe9bb508f2ca278805921\u0026amp;signature=2ad7ee0502b4eb0f918aa66ca4e6c54fe7a1f1da05aa153ed258f56df6c0e52c\">\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=\"Edit (re-authorize) a scheduled payout - Axra\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Replaces the recipient list / amounts (new hire, resignation, raise) WITHOUT recreating the schedule — the cadence, day-of-month and nextRunAt timing are preserved. Every edit re-authorizes: it re-validates the payload + per-run cap, sanctions-screens every recipient in the new payload, re-verifies the transaction PIN on the dashboard path (api-key exempt), and re-stamps authorizedAt/By. Only ACTIVE/PAUSED schedules are editable; changing the cadence/timing still requires recreating the schedule.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://axra.mintlify.app/_mintlify/api/og/v2?division=Payout+Schedules\u0026amp;title=Edit+%28re-authorize%29+a+scheduled+payout\u0026amp;description=Replaces+the+recipient+list+%2F+amounts+%28new+hire%2C+resignation%2C+raise%29+WITHOUT+recreating+the+schedule+%E2%80%94+the+cadence%2C+day-of-month+and+nextRunAt+timing+are+preser\u0026amp;theme=a3cbe9bb508f2ca278805921\u0026amp;signature=2ad7ee0502b4eb0f918aa66ca4e6c54fe7a1f1da05aa153ed258f56df6c0e52c\">\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/axra/5n58I_XtfnPFe0cK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Axra\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7C3AED\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.useaxra.com/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.useaxra.com/#organization\",\"name\":\"Axra\",\"url\":\"https://docs.useaxra.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/axra/Wy1MdLLmzpX7ePSr/logo.png?fit=max\u0026auto=format\u0026n=Wy1MdLLmzpX7ePSr\u0026q=85\u0026s=002e9d7a645844c1cebffb6f5549553e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.useaxra.com#website\",\"name\":\"Axra\",\"url\":\"https://docs.useaxra.com\",\"publisher\":{\"@id\":\"https://docs.useaxra.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.useaxra.com/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout#webpage\",\"url\":\"https://docs.useaxra.com/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout\",\"name\":\"Edit (re-authorize) a scheduled payout\",\"description\":\"Replaces the recipient list / amounts (new hire, resignation, raise) WITHOUT recreating the schedule — the cadence, day-of-month and nextRunAt timing are preserved. Every edit re-authorizes: it re-validates the payload + per-run cap, sanctions-screens every recipient in the new payload, re-verifies the transaction PIN on the dashboard path (api-key exempt), and re-stamps authorizedAt/By. Only ACTIVE/PAUSED schedules are editable; changing the cadence/timing still requires recreating the schedule.\",\"dateModified\":\"2026-10-14T17:34:38.884Z\",\"isPartOf\":{\"@id\":\"https://docs.useaxra.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.useaxra.com/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.useaxra.com/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payout Schedules\",\"item\":\"https://docs.useaxra.com/api-reference/payout-schedules/list-scheduled-payouts-for-the-active-business\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Edit (re-authorize) a scheduled payout\",\"item\":\"https://docs.useaxra.com/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.useaxra.com/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout#apireference\",\"headline\":\"Edit (re-authorize) a scheduled payout\",\"name\":\"Edit (re-authorize) a scheduled payout\",\"description\":\"Replaces the recipient list / amounts (new hire, resignation, raise) WITHOUT recreating the schedule — the cadence, day-of-month and nextRunAt timing are preserved. Every edit re-authorizes: it re-validates the payload + per-run cap, sanctions-screens every recipient in the new payload, re-verifies the transaction PIN on the dashboard path (api-key exempt), and re-stamps authorizedAt/By. Only ACTIVE/PAUSED schedules are editable; changing the cadence/timing still requires recreating the schedule.\",\"url\":\"https://docs.useaxra.com/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout\",\"mainEntityOfPage\":{\"@id\":\"https://docs.useaxra.com/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout#webpage\"},\"dateModified\":\"2026-10-14T17:34:38.884Z\",\"publisher\":{\"@id\":\"https://docs.useaxra.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.useaxra.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Axra\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Axra","nav":{"global":null,"tabs":[{"tab":"Get Started","icon":"play","pages":[{"title":"Get Started","href":"/introduction"}]},{"tab":"Developer Platform","icon":"code","pages":[{"title":"Developer Platform","href":"/payments/overview"}]},{"tab":"API Reference","icon":"rectangle-terminal","groups":[{"group":"Payout Recipients","pages":[{"title":"List payout recipients for the active business","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/payouts/recipients","href":"/api-reference/payout-recipients/list-payout-recipients-for-the-active-business"},{"title":"Create a payout recipient","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payouts/recipients","href":"/api-reference/payout-recipients/create-a-payout-recipient"},{"title":"Get a payout recipient by id","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/payouts/recipients/{id}","href":"/api-reference/payout-recipients/get-a-payout-recipient-by-id"},{"title":"Archive a payout recipient (soft delete)","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/business/payouts/recipients/{id}","href":"/api-reference/payout-recipients/archive-a-payout-recipient-soft-delete"},{"title":"Update recipient label","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/business/payouts/recipients/{id}","href":"/api-reference/payout-recipients/update-recipient-label"}]},{"group":"Payout Batches","pages":[{"title":"List batch payouts for the active business","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/payouts/batches","href":"/api-reference/payout-batches/list-batch-payouts-for-the-active-business"},{"title":"Create a draft batch payout (payroll) + preview","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payouts/batches","href":"/api-reference/payout-batches/create-a-draft-batch-payout-payroll-+-preview"},{"title":"Submit a draft batch for processing","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payouts/batches/{id}/submit","href":"/api-reference/payout-batches/submit-a-draft-batch-for-processing"},{"title":"Get a batch payout with its line items","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/payouts/batches/{id}","href":"/api-reference/payout-batches/get-a-batch-payout-with-its-line-items"},{"title":"Cancel a draft or queued batch","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payouts/batches/{id}/cancel","href":"/api-reference/payout-batches/cancel-a-draft-or-queued-batch"}]},{"group":"Payout Schedules","pages":[{"title":"List scheduled payouts for the active business","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/payouts/schedules","href":"/api-reference/payout-schedules/list-scheduled-payouts-for-the-active-business"},{"title":"Create + authorize a scheduled payout","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payouts/schedules","href":"/api-reference/payout-schedules/create-+-authorize-a-scheduled-payout"},{"title":"Get a scheduled payout","description":"Returns the schedule plus a MASKED list of its recipients (`items[]`): label, rail, corridor (country · currency), and the configured per-run amount only. No account numbers / IBAN / phone and no partner names are exposed.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/payouts/schedules/{id}","href":"/api-reference/payout-schedules/get-a-scheduled-payout"},{"title":"Edit (re-authorize) a scheduled payout","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/business/payouts/schedules/{id}","href":"/api-reference/payout-schedules/edit-re-authorize-a-scheduled-payout"},{"title":"Cancel a scheduled payout","description":"Sets status to CANCELLED (terminal). Idempotent on an already-cancelled schedule.","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/business/payouts/schedules/{id}","href":"/api-reference/payout-schedules/cancel-a-scheduled-payout"},{"title":"Pause / resume / rename a scheduled payout","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/business/payouts/schedules/{id}","href":"/api-reference/payout-schedules/pause-resume-rename-a-scheduled-payout"}]},{"group":"Payouts","pages":[{"title":"List supported banks / mobile money networks for a corridor","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/payouts/networks","href":"/api-reference/payouts/list-supported-banks-mobile-money-networks-for-a-corridor"},{"title":"Resolve a beneficiary name from a bank account number","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payouts/resolve-account","href":"/api-reference/payouts/resolve-a-beneficiary-name-from-a-bank-account-number"},{"title":"Get a cross-currency payout quote (60s lock)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payouts/quote","href":"/api-reference/payouts/get-a-cross-currency-payout-quote-60s-lock"},{"title":"List payouts for the active business","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/payouts","href":"/api-reference/payouts/list-payouts-for-the-active-business"},{"title":"Initiate a business payout","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payouts","href":"/api-reference/payouts/initiate-a-business-payout"},{"title":"Get a single business payout","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/payouts/{id}","href":"/api-reference/payouts/get-a-single-business-payout"},{"title":"Cancel a CREATED payout","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payouts/{id}/cancel","href":"/api-reference/payouts/cancel-a-created-payout"}]},{"group":"Authentication","pages":[{"title":"Authenticate with business API key and secret","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/auth/token","href":"/api-reference/authentication/authenticate-with-business-api-key-and-secret"},{"title":"Regenerate API key","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/regenerate-api-key","href":"/api-reference/authentication/regenerate-api-key"},{"title":"Self-onboard a SANDBOX developer partner (authenticated; requires completed identity verification). TEST keys only.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/treasury/signup","href":"/api-reference/authentication/self-onboard-a-sandbox-developer-partner-authenticated;-requires-completed-identity-verification-test-keys-only"},{"title":"Returns authenticated partner id (public contract surface)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/whoami","href":"/api-reference/authentication/returns-authenticated-partner-id-public-contract-surface"}]},{"group":"Payments","pages":[{"title":"List merchant pricing per corridor (aggregated total fee, no provider breakdown)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/psp-pricing","href":"/api-reference/payments/list-merchant-pricing-per-corridor-aggregated-total-fee-no-provider-breakdown"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payment","href":"/api-reference/payments/create-a-payment-link"},{"title":"Charge a card directly (server-to-server)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payment/charge","href":"/api-reference/payments/charge-a-card-directly-server-to-server"},{"title":"Confirm 3D Secure authentication","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payment/confirm-3ds","href":"/api-reference/payments/confirm-3d-secure-authentication"},{"title":"Get payment details","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/payment/{paymentId}","href":"/api-reference/payments/get-payment-details"},{"title":"Refund a payment","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payment/{paymentId}/refund","href":"/api-reference/payments/refund-a-payment"},{"title":"List payments","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/payments","href":"/api-reference/payments/list-payments"},{"title":"Create a checkout session","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/payment/session","href":"/api-reference/payments/create-a-checkout-session"}]},{"group":"Payment Links","pages":[{"title":"List payment links","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/links","href":"/api-reference/payment-links/list-payment-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/links","href":"/api-reference/payment-links/create-a-payment-link"},{"title":"Deactivate a payment link","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/business/links/{id}","href":"/api-reference/payment-links/deactivate-a-payment-link"},{"title":"Update a payment link","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/business/links/{id}","href":"/api-reference/payment-links/update-a-payment-link"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/customers","href":"/api-reference/customers/list-customers"},{"title":"Find customer by email","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/customers/email/{email}","href":"/api-reference/customers/find-customer-by-email"},{"title":"Retrieve a customer","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/customers/{customerId}","href":"/api-reference/customers/retrieve-a-customer"},{"title":"Remove a payment method","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/business/customers/{customerId}/payment-methods/{paymentMethodId}","href":"/api-reference/customers/remove-a-payment-method"},{"title":"Set default payment method","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/business/customers/{customerId}/default-payment-method","href":"/api-reference/customers/set-default-payment-method"}]},{"group":"Disputes","pages":[{"title":"Get merchant dispute defence policy","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/disputes/policy/current","href":"/api-reference/disputes/get-merchant-dispute-defence-policy"},{"title":"Update merchant dispute defence policy","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/business/disputes/policy/current","href":"/api-reference/disputes/update-merchant-dispute-defence-policy"},{"title":"Get dispute count summary (open / won / lost)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/disputes/stats","href":"/api-reference/disputes/get-dispute-count-summary-open-won-lost"},{"title":"List disputes for the authenticated merchant","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/disputes","href":"/api-reference/disputes/list-disputes-for-the-authenticated-merchant"},{"title":"Get dispute detail for a payment","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/disputes/{paymentId}","href":"/api-reference/disputes/get-dispute-detail-for-a-payment"},{"title":"Upload merchant dispute evidence file","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/disputes/{paymentId}/evidence/upload","href":"/api-reference/disputes/upload-merchant-dispute-evidence-file"},{"title":"Accept dispute loss (merchant opts not to contest)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/disputes/{paymentId}/accept-loss","href":"/api-reference/disputes/accept-dispute-loss-merchant-opts-not-to-contest"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints for the business (API key)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhook-endpoints","href":"/api-reference/webhooks/list-webhook-endpoints-for-the-business-api-key"},{"title":"Create a webhook endpoint (returns signing secret once)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/webhook-endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint-returns-signing-secret-once"},{"title":"Replay a webhook delivery (queues a new delivery)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/webhook-endpoints/replay-delivery","href":"/api-reference/webhooks/replay-a-webhook-delivery-queues-a-new-delivery"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhook-endpoints/{id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/webhook-endpoints/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/webhook-endpoints/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"List deliveries for a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhook-endpoints/{id}/deliveries","href":"/api-reference/webhooks/list-deliveries-for-a-webhook-endpoint"},{"title":"Rotate signing secret (returned once)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/webhook-endpoints/{id}/rotate-signing-secret","href":"/api-reference/webhooks/rotate-signing-secret-returned-once"},{"title":"List treasury webhook endpoints for the authenticated partner","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/webhook-endpoints","href":"/api-reference/webhooks/list-treasury-webhook-endpoints-for-the-authenticated-partner"},{"title":"Create a treasury webhook endpoint (signing secret returned once)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/treasury/webhook-endpoints","href":"/api-reference/webhooks/create-a-treasury-webhook-endpoint-signing-secret-returned-once"},{"title":"Replay a webhook delivery (queues a new delivery)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/treasury/webhook-endpoints/replay-delivery","href":"/api-reference/webhooks/replay-a-webhook-delivery-queues-a-new-delivery-1"},{"title":"Get a treasury webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/webhook-endpoints/{id}","href":"/api-reference/webhooks/get-a-treasury-webhook-endpoint"},{"title":"Delete a treasury webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/treasury/webhook-endpoints/{id}","href":"/api-reference/webhooks/delete-a-treasury-webhook-endpoint"},{"title":"Update a treasury webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/treasury/webhook-endpoints/{id}","href":"/api-reference/webhooks/update-a-treasury-webhook-endpoint"},{"title":"List deliveries for a treasury webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/webhook-endpoints/{id}/deliveries","href":"/api-reference/webhooks/list-deliveries-for-a-treasury-webhook-endpoint"},{"title":"Rotate signing secret (returned once)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/treasury/webhook-endpoints/{id}/rotate-signing-secret","href":"/api-reference/webhooks/rotate-signing-secret-returned-once-1"}]},{"group":"Fraud","pages":[{"title":"List fraud rules","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/fraud/rules","href":"/api-reference/fraud/list-fraud-rules"},{"title":"Create fraud rule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/fraud/rules","href":"/api-reference/fraud/create-fraud-rule"},{"title":"Evaluate fraud rules against sample payload","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/fraud/rules/test","href":"/api-reference/fraud/evaluate-fraud-rules-against-sample-payload"},{"title":"Get fraud rule","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/fraud/rules/{id}","href":"/api-reference/fraud/get-fraud-rule"},{"title":"Delete fraud rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/business/fraud/rules/{id}","href":"/api-reference/fraud/delete-fraud-rule"},{"title":"Update fraud rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/business/fraud/rules/{id}","href":"/api-reference/fraud/update-fraud-rule"},{"title":"List blocked entities (merchant-scoped + platform-wide)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/fraud/blocked","href":"/api-reference/fraud/list-blocked-entities-merchant-scoped-+-platform-wide"},{"title":"Unblock a blocked entity (merchant-scoped only)","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/business/fraud/blocked/{id}","href":"/api-reference/fraud/unblock-a-blocked-entity-merchant-scoped-only"}]},{"group":"Local Rails","pages":[{"title":"List local-rails collections","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/collections","href":"/api-reference/local-rails/list-local-rails-collections"},{"title":"Create a local-rails collection (S2S)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/business/collections","href":"/api-reference/local-rails/create-a-local-rails-collection-s2s"},{"title":"Retrieve a local-rails collection","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/collections/{id}","href":"/api-reference/local-rails/retrieve-a-local-rails-collection"},{"title":"Force-refresh a local-rails collection from the upstream provider","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/collections/{id}/refresh","href":"/api-reference/local-rails/force-refresh-a-local-rails-collection-from-the-upstream-provider"},{"title":"List available local-rail channels","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/business/local-rails/channels","href":"/api-reference/local-rails/list-available-local-rail-channels"}]},{"group":"Treasury — KYC","pages":[{"title":"Sandbox-only: manually approve pending KYC for an end-user","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/treasury/users/{id}/kyc/sandbox-approve","href":"/api-reference/treasury-—-kyc/sandbox-only:-manually-approve-pending-kyc-for-an-end-user"},{"title":"Sandbox-only: manually reject pending KYC for an end-user","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/treasury/users/{id}/kyc/sandbox-reject","href":"/api-reference/treasury-—-kyc/sandbox-only:-manually-reject-pending-kyc-for-an-end-user"},{"title":"Get current KYC status for an end-user","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/users/{id}/kyc","href":"/api-reference/treasury-—-kyc/get-current-kyc-status-for-an-end-user"},{"title":"Initiate KYC verification for an end-user","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/treasury/users/{id}/kyc","href":"/api-reference/treasury-—-kyc/initiate-kyc-verification-for-an-end-user"}]},{"group":"Treasury — End-Users","pages":[{"title":"List treasury end-users","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/users","href":"/api-reference/treasury-—-end-users/list-treasury-end-users"},{"title":"Create a treasury end-user","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/treasury/users","href":"/api-reference/treasury-—-end-users/create-a-treasury-end-user"},{"title":"Get a treasury end-user by id","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/users/{id}","href":"/api-reference/treasury-—-end-users/get-a-treasury-end-user-by-id"},{"title":"Soft-delete a treasury end-user (status CLOSED)","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/treasury/users/{id}","href":"/api-reference/treasury-—-end-users/soft-delete-a-treasury-end-user-status-closed"},{"title":"Update a treasury end-user","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/treasury/users/{id}","href":"/api-reference/treasury-—-end-users/update-a-treasury-end-user"}]},{"group":"Treasury — Wallets","pages":[{"title":"Sandbox-only: credit a wallet for integration testing","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/treasury/users/{id}/wallets/{walletId}/sandbox-credit","href":"/api-reference/treasury-—-wallets/sandbox-only:-credit-a-wallet-for-integration-testing"},{"title":"List an end-user's wallets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/users/{id}/wallets","href":"/api-reference/treasury-—-wallets/list-an-end-users-wallets"},{"title":"Provision a wallet for an end-user (currency-scoped)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/treasury/users/{id}/wallets","href":"/api-reference/treasury-—-wallets/provision-a-wallet-for-an-end-user-currency-scoped"},{"title":"Get wallet detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/users/{id}/wallets/{walletId}","href":"/api-reference/treasury-—-wallets/get-wallet-detail"},{"title":"Get wallet balance from ledger","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/users/{id}/wallets/{walletId}/balance","href":"/api-reference/treasury-—-wallets/get-wallet-balance-from-ledger"},{"title":"Deposit instructions (fiat VA and/or crypto liquidation address)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/users/{id}/wallets/{walletId}/deposit_instructions","href":"/api-reference/treasury-—-wallets/deposit-instructions-fiat-va-andor-crypto-liquidation-address"},{"title":"Partner ledger entries for this wallet currency (paginated)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/users/{id}/wallets/{walletId}/transactions","href":"/api-reference/treasury-—-wallets/partner-ledger-entries-for-this-wallet-currency-paginated"}]},{"group":"Treasury — Payouts","pages":[{"title":"List payouts for the authenticated partner","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/payouts","href":"/api-reference/treasury-—-payouts/list-payouts-for-the-authenticated-partner"},{"title":"Initiate a payout from an end-user wallet","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/treasury/payouts","href":"/api-reference/treasury-—-payouts/initiate-a-payout-from-an-end-user-wallet"},{"title":"Get payout by id","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/treasury/payouts/{id}","href":"/api-reference/treasury-—-payouts/get-payout-by-id"},{"title":"Cancel a payout if it is still PENDING","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/treasury/payouts/{id}/cancel","href":"/api-reference/treasury-—-payouts/cancel-a-payout-if-it-is-still-pending"}]},{"group":"Corridor Status","pages":[{"title":"Check which corridors are usable right now","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/status/corridors","href":"/api-reference/corridor-status/check-which-corridors-are-usable-right-now"}]},{"group":"Elements","pages":[{"title":"Create an ephemeral Elements session (publishable key + amount + currency)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/elements/session","href":"/api-reference/elements/create-an-ephemeral-elements-session-publishable-key-+-amount-+-currency"},{"title":"Tokenize card data for a session (iframe / allowed origins only)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/elements/tokenize","href":"/api-reference/elements/tokenize-card-data-for-a-session-iframe-allowed-origins-only"}]}]}]},"title":"Edit (re-authorize) a scheduled payout - Axra","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}