Array of transaction parties. Each party defines a recipient, approver, or interested party for the disbursement notification. At least one party with role: 0 (recipient) and recipient_enabled: 1 is required.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Ingo Payments Developer Hub","description":"Ingo Payments Developer Hub — APIs, SDKs, and integration guides.","colors":{"primary":"#23ad4b","light":"#5dcaa5","dark":"#058237"},"logo":{"light":"https://mintcdn.com/ingopayments/iShoHhbLzbG-YOtN/logo/light.svg?fit=max\u0026auto=format\u0026n=iShoHhbLzbG-YOtN\u0026q=85\u0026s=556c65165f3a5daf3e33eaf145664046","dark":"https://mintcdn.com/ingopayments/iShoHhbLzbG-YOtN/logo/dark.svg?fit=max\u0026auto=format\u0026n=iShoHhbLzbG-YOtN\u0026q=85\u0026s=52323e8aa1687a6fbdd29a6351b84fcf"},"favicon":"https://mintcdn.com/ingopayments/V3R8LABa_ahl2WE8/favicon.svg?fit=max\u0026auto=format\u0026n=V3R8LABa_ahl2WE8\u0026q=85\u0026s=b46af7ead1c5e85e3fe5d6813b1be106","api":{"openapi":["specs/iframe-session-create.yaml","specs/ingo-banking-merchant-ledgering.yaml","specs/ingopay-check-cancel.yaml","specs/ingopay-check-stop.yaml","specs/ingopay-debit-process-ach.yaml","specs/ingopay-debit-process-card.yaml","specs/ingopay-notify-v3.yaml","specs/ingopay-notify-v4.yaml","specs/ingopay-process-ach.yaml","specs/ingopay-process-billpay.yaml","specs/ingopay-process-card.yaml","specs/ingopay-process-check.yaml","specs/ingopay-process-paypal-venmo.yaml","specs/ingopay-process-retail-card-present.yaml","specs/ingopay-risk.yaml","specs/ingopay-search-v11.yaml","specs/ingopay-verify-ach.yaml","specs/ingopay-verify-billpay.yaml","specs/ingopay-verify-card.yaml","specs/ingopay-verify-check.yaml","specs/ingopay-verify-paypal-venmo.yaml","specs/ingopay-verify-retail-card-present.yaml","specs/ingopay-open-banking-account.yaml","specs/crms-check-maker-alert.yaml","specs/crms-check-protect.yaml","specs/crms-duplicate-exchange.yaml","specs/crms-fraud-alert.yaml","specs/crms-sdk-card-add-or-update-tokenized.yaml","specs/crms-sdk-card-add-or-update.yaml","specs/crms-sdk-card-delete.yaml","specs/crms-sdk-card-get-registered-cards.yaml","specs/crms-sdk-card-update-account.yaml","specs/crms-sdk-partners-add-customer-attributes.yaml","specs/crms-sdk-partners-add-session-attributes.yaml","specs/crms-sdk-partners-authenticate-obo.yaml","specs/crms-sdk-partners-authenticate.yaml","specs/crms-sdk-partners-enroll-customer.yaml","specs/crms-sdk-partners-find-customer.yaml","specs/crms-sdk-partners-get-transaction-history.yaml","specs/crms-sdk-paypal-register-customer.yaml"],"asyncapi":["specs/asyncapi-ingopay.yaml","specs/asyncapi-notify-v3.yaml","specs/asyncapi-notify-v4.yaml","specs/asyncapi-iframe.yaml","specs/asyncapi-banking.yaml","specs/asyncapi-crms-sdk.yaml","specs/asyncapi-crms-check-protect.yaml"],"playground":{"display":"simple"}},"appearance":{"default":"dark"},"contextual":{"options":["copy","view","claude","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ingopayments","hasAudioNarration":false,"actualSubdomain":"ingopayments","customDomains":["developers.ingopayments.com"],"gitSource":{"type":"github","owner":"ingopayments","repo":"ingo-developer-center","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ada84e0793a44c014900f96","collectionId":"78d95d12-1fbc-4af9-94cd-d9532bf64744","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada84e0793a44c014900f96"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae1f353201cdb70a522441a","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Webhooks","count":242},{"language":"default","tag":"Banking Platform","count":81},{"language":"default","tag":"API Reference","count":74},{"language":"default","tag":"Notify — Managed Parties","count":56},{"language":"default","tag":"Notify — Classic","count":42},{"language":"default","tag":"IngoPay API","count":37},{"language":"default","tag":"Embedded Account Capture","count":22},{"language":"default","tag":"Overview","count":20},{"language":"default","tag":"Hub","count":17},{"language":"default","tag":"Business Owners \u0026 Documents","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#navbar>div>div:first-child{border-bottom:3px solid #23ad4b!important;border-color:#23ad4b!important}nav a.link.rounded-full{height:40px!important;font-size:13.5px!important;padding-left:16px!important;padding-right:16px!important;transition:background .15s ease,color .15s ease,border-color .15s ease!important}nav a.link.rounded-full:not(.text-gray-600){background-color:#23ad4b!important;color:#fff!important;font-weight:700!important}nav a.link.rounded-full.text-gray-600{border:1px solid transparent!important;background-color:transparent!important}nav a.link.rounded-full.text-gray-600:hover{border-color:#23ad4b!important;color:#23ad4b!important;background-color:transparent!important}.spec-btn,.spec-btn:hover{text-decoration:none!important}.spec-btn{display:inline-block;background:0 0;border:1px solid #23ad4b;color:#23ad4b!important;font-size:12px;font-weight:600;padding:5px 14px;border-radius:20px;transition:background .15s ease,color .15s ease,border-color .15s ease}.spec-btn:hover{background:#23ad4b;color:#fff!important}.dark table th{color:#e2e8f0!important}img[src*=\"/crms/sdk/screens/\"]{border-radius:24px;max-width:280px;background:#fff;border:1px solid rgba(0,0,0,.18);box-shadow:0 6px 16px rgba(0,0,0,.12)}.dark img[src*=\"/crms/sdk/screens/\"]{border:1px solid rgba(255,255,255,.15);box-shadow:0 6px 16px rgba(0,0,0,.4)}.screen-row{display:grid;grid-template-columns:repeat(auto-fit,minmax(420px,1fr));gap:36px;margin:28px 0}.screen-card{display:grid;grid-template-columns:160px 1fr;gap:20px;align-items:start}.screen-card img{max-width:160px!important;width:100%}.screen-card .screen-text h4,.screen-card .screen-text strong:first-child{display:block;font-size:15px;font-weight:700;margin-top:0;margin-bottom:8px;line-height:1.3}.screen-card .screen-text p{margin:0 0 8px;font-size:14px;line-height:1.55}@media (max-width:540px){.screen-card{grid-template-columns:1fr;gap:12px}.screen-card img{max-width:200px!important;margin:0 auto}}.mermaid svg,div[class*=mermaid] svg,pre.mermaid svg{height:auto!important;margin:0 auto;display:block}.diagram-links{margin:8px 0 4px;font-size:.85rem;text-align:right}.diagram-links a{font-weight:500;text-decoration:none;border-bottom:1px solid currentColor}.diagram-accordion{position:relative;padding-left:14px;margin:28px 0;transition:transform .18s ease}.diagram-accordion::before{content:\"\";position:absolute;left:0;top:6px;bottom:6px;width:4px;background:#1a73e8;border-radius:2px;pointer-events:none;transition:background .18s ease,width .18s ease}.diagram-accordion:hover,.sdk-download-cta:hover{transform:translateY(-1px)}.diagram-accordion:hover::before{background:#4a90f0;width:5px}.sdk-download-cta{position:relative;margin:24px 0;padding:6px;border:2px solid #23ad4b;border-radius:14px;background:rgba(35,173,75,.06);box-shadow:0 4px 14px rgba(35,173,75,.18);transition:transform .18s ease,box-shadow .18s ease}.sdk-download-cta:hover{box-shadow:0 6px 20px rgba(35,173,75,.28)}.dark .sdk-download-cta{background:rgba(35,173,75,.12);box-shadow:0 4px 14px rgba(0,0,0,.4)}.report-downloads{display:flex;flex-wrap:wrap;gap:14px;margin:20px 0 4px}.report-downloads a.report-dl-btn{display:inline-flex;align-items:center;gap:9px;background:#23ad4b;color:#fff!important;font-size:14px;font-weight:600;padding:11px 20px;border-radius:10px;text-decoration:none!important;border:1px solid #23ad4b;box-shadow:0 2px 8px rgba(35,173,75,.2);transition:transform .15s ease,box-shadow .15s ease,background .15s ease}.report-downloads a.report-dl-btn::before{content:\"\\2193\";font-size:15px;font-weight:700;line-height:1}.report-downloads a.report-dl-btn:hover{background:#1c8f3d;transform:translateY(-1px);box-shadow:0 5px 16px rgba(35,173,75,.32);text-decoration:none!important}.dark .report-downloads a.report-dl-btn{box-shadow:0 2px 8px rgba(0,0,0,.4)}"}],"page":{"pagePath":"docs/notify-managed/notify/stage","slug":"/docs/notify-managed/notify/stage","pageMetadata":{"title":"Stage Disbursement","description":"Stage a disbursement with one or more parties via Notify v4.","openapi":"specs/ingopay-notify-v4.yaml POST /gateway/v4/notify","href":"/docs/notify-managed/notify/stage"},"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: \"Stage a disbursement with one or more parties via Notify v4.\"\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":"Stage Disbursement","description":"Stage a disbursement with one or more parties via Notify v4.","openapi":"specs/ingopay-notify-v4.yaml POST /gateway/v4/notify","href":"/docs/notify-managed/notify/stage"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ingopayments/6302b08f7c932246/scripts/convert.js","/_mintlify/custom/ingopayments/803ba8a0d7080d96/scripts/generate-from-code.js","/_mintlify/custom/ingopayments/20b0b95f387de69d/scripts/validate.js","/_mintlify/custom/ingopayments/e31e657fa2223781/scripts/export-diagrams.js"],"openApiReferenceData":{"operation":{"summary":"Submit a notification of payment intent (v4)","description":"Stage a disbursement with one or more parties via Notify v4.","operationId":"notifyV4","tags":["Notification of Payment Intent"],"requestBody":"bb00f391-0e43-43e1-ba64-560eeff035fa","responses":{"200":"cbe3556a-f7e3-413d-a816-b4b7939337c2","400":"129c89fe-000b-42b6-80a2-7b00116c0ae4"},"method":"post","type":"path","servers":["37d4af47-30c4-497a-b4a6-e14b95f4b864","8f91c894-20b3-425b-9b4b-3e7b6f246fa0"],"security":["6bbf8852-8ef0-4a60-9df5-0eb859f54fde"],"path":"/gateway/v4/notify","baseUrlOptions":["https://payapi-sandbox.ingo.money","https://payapi.ingo.money"],"title":"Submit a notification of payment intent (v4)","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["request","transaction","transaction_parties"],"properties":{"request":{"type":"object","required":["participant_id","timestamp"],"description":"General information associated with the API request.","properties":{"participant_id":{"type":"integer","description":"Unique participant identifier assigned by Ingo.","example":12345,"isRequired":true,"uniqueKey":"request.participant_id","typeLabel":"integer"},"timestamp":{"type":"integer","description":"Unix timestamp of the request. Must not exceed the current time by more than 30 minutes.\n","example":1745356800,"isRequired":true,"uniqueKey":"request.timestamp","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"request","typeLabel":"object"},"transaction":{"type":"object","required":["transaction_amount","participant_unique_ids","workflow_id","notify_type"],"description":"Transaction-level information for the disbursement notification.","properties":{"transaction_amount":{"type":"object","required":["amount","currency_code"],"properties":{"amount":{"type":"number","format":"float","maximum":9999999999.99,"description":"Dollar amount of the disbursement.","example":250,"isRequired":true,"uniqueKey":"transaction.transaction_amount.amount","typeLabel":"number\u003cfloat>"},"currency_code":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$","description":"3-character ISO-4217 (alpha) currency code.","example":"USD","isRequired":true,"uniqueKey":"transaction.transaction_amount.currency_code","typeLabel":"string"}},"isRequired":true,"uniqueKey":"transaction.transaction_amount","typeLabel":"object"},"participant_unique_ids":{"type":"object","required":["participant_unique_id1"],"properties":{"participant_unique_id1":{"type":"string","minLength":1,"maxLength":100,"description":"Participant assigned transaction ID. Must be unique. Used for idempotency. Appears on daily reconciliation reports.\n","example":"a4f1b2c3-d456-789e-f012-34567890abcd","isRequired":true,"uniqueKey":"transaction.participant_unique_ids.participant_unique_id1","typeLabel":"string"},"participant_unique_id2":{"oneOf":[{"type":"string","maxLength":100,"description":"Optional second participant assigned transaction ID.","example":"b5e2c3d4-e567-890f-a123-456789012345","uniqueKey":"transaction.participant_unique_ids.participant_unique_id2.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"description":"Optional second participant assigned transaction ID.","example":"b5e2c3d4-e567-890f-a123-456789012345","uniqueKey":"transaction.participant_unique_ids.participant_unique_id2.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction.participant_unique_ids.participant_unique_id2","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"transaction.participant_unique_ids","typeLabel":"object"},"workflow_id":{"type":"integer","description":"Ingo assigned workflow ID that determines the notification and authentication flow. Assigned during client onboarding.\n","example":1,"isRequired":true,"uniqueKey":"transaction.workflow_id","typeLabel":"integer"},"notify_type":{"type":"integer","enum":[0,1,2,3],"description":"Disbursement flow type. 0 = Standard disbursement (one-time), 1 = Enrollment only (recurring), 2 = Disbursement only (recurring — party must already be enrolled), 3 = Enrollment and disbursement (recurring).\n","example":0,"isRequired":true,"uniqueKey":"transaction.notify_type","typeLabel":"enum\u003cinteger>"},"secure_link_1":{"oneOf":[{"type":"string","maxLength":250,"description":"Optional secure link to include in the notification.","example":null,"uniqueKey":"transaction.secure_link_1.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":250,"description":"Optional secure link to include in the notification.","example":null,"uniqueKey":"transaction.secure_link_1.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction.secure_link_1","typeLabel":"string | null"},"document_link":{"oneOf":[{"type":"string","maxLength":2048,"description":"Optional URL to a document embedded in the notification. Required when the client is configured for document embedding (`document_embedding_enabled`).\n","example":"https://example.com/documents/agreement.pdf","uniqueKey":"transaction.document_link.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":2048,"description":"Optional URL to a document embedded in the notification. Required when the client is configured for document embedding (`document_embedding_enabled`).\n","example":"https://example.com/documents/agreement.pdf","uniqueKey":"transaction.document_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction.document_link","typeLabel":"string | null"},"language":{"oneOf":[{"type":"string","maxLength":8,"description":"Optional language code for the recipient notification. Required when configured for alternate language support.\n","example":"es","uniqueKey":"transaction.language.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":8,"description":"Optional language code for the recipient notification. Required when configured for alternate language support.\n","example":"es","uniqueKey":"transaction.language.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction.language","typeLabel":"string | null"},"sender":{"type":"object","description":"Sender information. Required when the client is configured with `require_sender_data`. Contact your Ingo integration manager to confirm.\n","required":["name_personal","contact_address","contact_telcom","sender_account"],"properties":{"name_personal":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","minLength":1,"maxLength":150,"description":"Sender first name.","example":"Ingo","isRequired":true,"uniqueKey":"transaction.sender.name_personal.first_name","typeLabel":"string"},"last_name":{"type":"string","minLength":1,"maxLength":150,"description":"Sender last name.","example":"Money","isRequired":true,"uniqueKey":"transaction.sender.name_personal.last_name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"transaction.sender.name_personal","typeLabel":"object"},"contact_address":{"type":"object","required":["address1","city","state","zip"],"properties":{"address1":{"type":"string","minLength":1,"maxLength":150,"description":"Sender address line 1.","example":"100 Innovation Way","isRequired":true,"uniqueKey":"transaction.sender.contact_address.address1","typeLabel":"string"},"city":{"type":"string","minLength":1,"maxLength":150,"description":"Sender city.","example":"Peachtree Corners","isRequired":true,"uniqueKey":"transaction.sender.contact_address.city","typeLabel":"string"},"state":{"type":"string","minLength":2,"maxLength":2,"pattern":"^(?:A[LKSZRAEP]|C[AOT]|D[EC]|F[LM]|G[AU]|HI|I[ADLN]|K[SY]|LA|M[ADEHINOPST]|N[CDEHJMVY]|O[HKR]|P[ARW]|RI|S[CD]|T[NX]|UT|V[AIT]|W[AIVY])$","description":"Sender state (standard US postal abbreviation).","example":"GA","isRequired":true,"uniqueKey":"transaction.sender.contact_address.state","typeLabel":"string"},"zip":{"type":"string","maxLength":10,"pattern":"^[0-9]{5}(?:-[0-9]{4})?$","description":"Sender zip code.","example":"30092","isRequired":true,"uniqueKey":"transaction.sender.contact_address.zip","typeLabel":"string"},"address2":{"oneOf":[{"type":"string","maxLength":150,"description":"Optional sender address line 2.","example":null,"uniqueKey":"transaction.sender.contact_address.address2.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":150,"description":"Optional sender address line 2.","example":null,"uniqueKey":"transaction.sender.contact_address.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction.sender.contact_address.address2","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"transaction.sender.contact_address","typeLabel":"object"},"contact_telcom":{"type":"object","required":["email"],"properties":{"email":{"type":"string","minLength":1,"maxLength":150,"description":"Sender email address.","example":"noreply@example.com","isRequired":true,"uniqueKey":"transaction.sender.contact_telcom.email","typeLabel":"string"}},"isRequired":true,"uniqueKey":"transaction.sender.contact_telcom","typeLabel":"object"},"sender_account":{"type":"string","minLength":1,"maxLength":100,"description":"Client assigned sender account identifier.\n","example":"sender-acct-001","isRequired":true,"uniqueKey":"transaction.sender.sender_account","typeLabel":"string"}},"uniqueKey":"transaction.sender","typeLabel":"object"},"check_disbursement":{"type":"object","description":"Check disbursement data, used when the disbursement is fulfilled by check. Conditional - required for check-enabled clients when at least one party has recipient_enabled of 1, and not required for notify_type 1 (enrollment-only recurring). Omit for clients not configured for check disbursement.","required":["check_delivery"],"properties":{"check_delivery":{"type":"object","description":"Check delivery information, the payee lines and mailing address used to print and mail the check.","required":["pay_to","address"],"properties":{"pay_to":{"type":"object","required":["pay_to_line_1"],"properties":{"pay_to_line_1":{"type":"string","maxLength":75,"description":"Primary pay-to line printed on the check.","example":"Johnny Rockets","isRequired":true,"uniqueKey":"transaction.check_disbursement.check_delivery.pay_to.pay_to_line_1","typeLabel":"string"},"pay_to_line_2":{"oneOf":[{"type":"string","maxLength":75,"description":"Optional secondary pay-to line.","example":null,"uniqueKey":"transaction.check_disbursement.check_delivery.pay_to.pay_to_line_2.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":75,"description":"Optional secondary pay-to line.","example":null,"uniqueKey":"transaction.check_disbursement.check_delivery.pay_to.pay_to_line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction.check_disbursement.check_delivery.pay_to.pay_to_line_2","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"transaction.check_disbursement.check_delivery.pay_to","typeLabel":"object"},"address":{"type":"object","required":["address1","city","state","zip"],"properties":{"address1":{"type":"string","maxLength":40,"description":"Mailing address line 1.","example":"123 Main St.","isRequired":true,"uniqueKey":"transaction.check_disbursement.check_delivery.address.address1","typeLabel":"string"},"city":{"type":"string","maxLength":24,"description":"Mailing city.","example":"Atlanta","isRequired":true,"uniqueKey":"transaction.check_disbursement.check_delivery.address.city","typeLabel":"string"},"state":{"type":"string","minLength":2,"maxLength":2,"description":"Mailing state (standard US postal abbreviation).","example":"GA","isRequired":true,"uniqueKey":"transaction.check_disbursement.check_delivery.address.state","typeLabel":"string"},"zip":{"type":"string","maxLength":10,"pattern":"^[0-9]{5}(?:-[0-9]{4})?$","description":"Mailing zip code.","example":"30313","isRequired":true,"uniqueKey":"transaction.check_disbursement.check_delivery.address.zip","typeLabel":"string"},"address2":{"oneOf":[{"type":"string","maxLength":40,"description":"Optional mailing address line 2.","example":"Apt 3","uniqueKey":"transaction.check_disbursement.check_delivery.address.address2.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":40,"description":"Optional mailing address line 2.","example":"Apt 3","uniqueKey":"transaction.check_disbursement.check_delivery.address.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction.check_disbursement.check_delivery.address.address2","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"transaction.check_disbursement.check_delivery.address","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.check_disbursement.check_delivery","typeLabel":"object"},"check_memo_stub":{"type":"object","description":"Information printed on the check memo line and stub in the event of a check disbursement.","required":["memo_line"],"properties":{"memo_line":{"type":"string","description":"Text printed on the memo line of the check. Maximum length is validated per the check provider configured for the client.","example":"Claim 00123 settlement","isRequired":true,"uniqueKey":"transaction.check_disbursement.check_memo_stub.memo_line","typeLabel":"string"},"stub_lines":{"oneOf":[{"type":"array","description":"Optional freeform lines printed on the check stub to convey remittance or posting detail to the payee.","items":{"type":"object","required":["text","order"],"properties":{"text":{"type":"string","maxLength":193,"description":"Freeform stub line text. Maximum length is validated per the check provider.","example":"Policy 4456 - March payment","isRequired":true,"uniqueKey":"transaction.check_disbursement.check_memo_stub.stub_lines.oneOf.0.items.[INDEX].text","typeLabel":"string"},"order":{"type":"integer","description":"Order in which this stub line is printed relative to other stub lines. Must be unique within the array.","example":1,"isRequired":true,"uniqueKey":"transaction.check_disbursement.check_memo_stub.stub_lines.oneOf.0.items.[INDEX].order","typeLabel":"integer"}},"uniqueKey":"transaction.check_disbursement.check_memo_stub.stub_lines.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transaction.check_disbursement.check_memo_stub.stub_lines.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Optional freeform lines printed on the check stub to convey remittance or posting detail to the payee.","items":{"type":"object","required":["text","order"],"properties":{"text":{"type":"string","maxLength":193,"description":"Freeform stub line text. Maximum length is validated per the check provider.","example":"Policy 4456 - March payment"},"order":{"type":"integer","description":"Order in which this stub line is printed relative to other stub lines. Must be unique within the array.","example":1}}},"uniqueKey":"transaction.check_disbursement.check_memo_stub.stub_lines.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction.check_disbursement.check_memo_stub.stub_lines","typeLabel":"object[] | null"}},"uniqueKey":"transaction.check_disbursement.check_memo_stub","typeLabel":"object"}},"uniqueKey":"transaction.check_disbursement","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction","typeLabel":"object"},"transaction_parties":{"type":"array","minItems":1,"description":"Array of transaction parties. Each party defines a recipient, approver, or interested party for the disbursement notification. At least one party with `role: 0` (recipient) and `recipient_enabled: 1` is required.\n","items":{"type":"object","required":["settings","contact_telcom","contact_address"],"description":"Individual party in the disbursement notification. Provide either `name_personal{}` (individual) or `name_business` (business name string) — not both.\n","properties":{"settings":{"type":"object","required":["role","classification","recipient_enabled"],"description":"Party configuration settings that define the party's role in the disbursement flow.\n","properties":{"role":{"type":"integer","enum":[0,1,2],"description":"Party role. 0 = Recipient, 1 = Approver, 2 = Interested party. When `multiparty_enabled` is false, only role `0` (Recipient) is accepted.\n","example":0,"isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].settings.role","typeLabel":"enum\u003cinteger>"},"classification":{"type":"integer","enum":[1,2],"description":"Party classification. 1 = Individual, 2 = Business.\n","example":1,"isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].settings.classification","typeLabel":"enum\u003cinteger>"},"recipient_enabled":{"type":"integer","enum":[0,1],"description":"Whether this party is enabled to receive the disbursement. 1 = Enabled, 0 = Notification only (no disbursement). At least one party must have `recipient_enabled: 1`.\n","example":1,"isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].settings.recipient_enabled","typeLabel":"enum\u003cinteger>"},"client_provided_id":{"type":"string","minLength":1,"maxLength":50,"description":"Client assigned identifier for this party. Required for `notify_type: 0`, `1`, and `3`. Not required for `notify_type: 2` (disbursement-only recurring — uses `party_id` instead). Must not be the value `default_check`.\n","example":"party-001","uniqueKey":"transaction_parties.items.[INDEX].settings.client_provided_id","typeLabel":"string"},"party_id":{"type":"string","minLength":1,"maxLength":36,"description":"Ingo assigned party identifier for recurring disbursements. Required for `notify_type: 2` (disbursement-only recurring). UUID or `1` for default.\n","example":"1","uniqueKey":"transaction_parties.items.[INDEX].settings.party_id","typeLabel":"string"},"open_banking_finicity":{"oneOf":[{"type":"object","description":"Open banking account identification via Finicity. Optional — only applicable for clients configured to use Finicity for open banking services (open banking enabled with Finicity as the provider).","required":["customer_id"],"properties":{"customer_id":{"type":"string","maxLength":50,"description":"Finicity customer ID.","example":"FINICITY-CUST-001","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].settings.open_banking_finicity.oneOf.0.customer_id","typeLabel":"string"}},"uniqueKey":"transaction_parties.items.[INDEX].settings.open_banking_finicity.oneOf.0","typeLabel":"object"},{"type":"null","description":"Open banking account identification via Finicity. Optional — only applicable for clients configured to use Finicity for open banking services (open banking enabled with Finicity as the provider).","required":["customer_id"],"properties":{"customer_id":{"type":"string","maxLength":50,"description":"Finicity customer ID.","example":"FINICITY-CUST-001"}},"uniqueKey":"transaction_parties.items.[INDEX].settings.open_banking_finicity.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction_parties.items.[INDEX].settings.open_banking_finicity","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].settings","typeLabel":"object"},"contact_telcom":{"type":"object","required":["email"],"description":"Party contact telecommunication information.","properties":{"email":{"type":"string","minLength":1,"maxLength":150,"description":"Party email address. The disbursement notification is sent to this address.\n","example":"johnny.rockets@example.com","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].contact_telcom.email","typeLabel":"string"},"phone_mobile":{"oneOf":[{"type":"string","maxLength":10,"description":"10-digit party mobile number. Conditionality depends on OTAC client configuration.\n","example":"4045551234","uniqueKey":"transaction_parties.items.[INDEX].contact_telcom.phone_mobile.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":10,"description":"10-digit party mobile number. Conditionality depends on OTAC client configuration.\n","example":"4045551234","uniqueKey":"transaction_parties.items.[INDEX].contact_telcom.phone_mobile.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction_parties.items.[INDEX].contact_telcom.phone_mobile","typeLabel":"string | null"},"phone_home":{"oneOf":[{"type":"string","maxLength":10,"description":"Optional 10-digit party home phone number.","example":null,"uniqueKey":"transaction_parties.items.[INDEX].contact_telcom.phone_home.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":10,"description":"Optional 10-digit party home phone number.","example":null,"uniqueKey":"transaction_parties.items.[INDEX].contact_telcom.phone_home.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction_parties.items.[INDEX].contact_telcom.phone_home","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].contact_telcom","typeLabel":"object"},"contact_address":{"type":"object","required":["address1","city","state","zip"],"description":"Party postal address.","properties":{"address1":{"type":"string","minLength":1,"maxLength":150,"description":"Party address line 1.","example":"123 Main St.","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].contact_address.address1","typeLabel":"string"},"city":{"type":"string","minLength":1,"maxLength":150,"description":"Party city.","example":"Atlanta","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].contact_address.city","typeLabel":"string"},"state":{"type":"string","minLength":2,"maxLength":2,"pattern":"^(?:A[LKSZRAEP]|C[AOT]|D[EC]|F[LM]|G[AU]|HI|I[ADLN]|K[SY]|LA|M[ADEHINOPST]|N[CDEHJMVY]|O[HKR]|P[ARW]|RI|S[CD]|T[NX]|UT|V[AIT]|W[AIVY])$","description":"Party state (standard US postal abbreviation).","example":"GA","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].contact_address.state","typeLabel":"string"},"zip":{"type":"string","maxLength":10,"pattern":"^[0-9]{5}(?:-[0-9]{4})?$","description":"Party zip code.","example":"30313","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].contact_address.zip","typeLabel":"string"},"address2":{"oneOf":[{"type":"string","maxLength":150,"description":"Optional party address line 2.","example":"Apt 3","uniqueKey":"transaction_parties.items.[INDEX].contact_address.address2.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":150,"description":"Optional party address line 2.","example":"Apt 3","uniqueKey":"transaction_parties.items.[INDEX].contact_address.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction_parties.items.[INDEX].contact_address.address2","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].contact_address","typeLabel":"object"},"name_personal":{"type":"object","description":"Individual name for the party. Provide either `name_personal{}` or `name_business` — not both.\n","required":["first_name","last_name"],"properties":{"first_name":{"type":"string","minLength":1,"maxLength":150,"description":"Party first name.","example":"Johnny","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].name_personal.first_name","typeLabel":"string"},"last_name":{"type":"string","minLength":1,"maxLength":150,"description":"Party last name.","example":"Rockets","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].name_personal.last_name","typeLabel":"string"}},"uniqueKey":"transaction_parties.items.[INDEX].name_personal","typeLabel":"object"},"name_business":{"oneOf":[{"type":"string","minLength":1,"maxLength":150,"description":"Business name for the party. Provide instead of `name_personal{}` for business parties. Requires `enable_business_name` client configuration.\n","example":null,"uniqueKey":"transaction_parties.items.[INDEX].name_business.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":150,"description":"Business name for the party. Provide instead of `name_personal{}` for business parties. Requires `enable_business_name` client configuration.\n","example":null,"uniqueKey":"transaction_parties.items.[INDEX].name_business.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction_parties.items.[INDEX].name_business","typeLabel":"string | null"},"authentication":{"oneOf":[{"type":"array","minItems":1,"description":"Array of authentication challenge records for this party. Maximum count determined by client configuration (`max_authentication_records`).\n","items":{"type":"object","required":["field_label","field_order","validation_type","match_failure_type","value_format","client_provided_value"],"properties":{"field_label":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[A-Za-z0-9\\-\\/ ]+$","description":"Display label for the authentication field. Accepts letters, numbers, hyphens, forward slashes, and spaces.\n","example":"Last 4 SSN","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].authentication.oneOf.0.items.[INDEX].field_label","typeLabel":"string"},"field_order":{"type":"integer","minimum":1,"maximum":99,"description":"Display order for the authentication field. Must be unique within the array.\n","example":1,"isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].authentication.oneOf.0.items.[INDEX].field_order","typeLabel":"integer"},"validation_type":{"type":"integer","enum":[0,1,2,3],"description":"Validation behavior type per NOTIFY_TYPES_V4. 0–3 accepted.\n","example":1,"isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].authentication.oneOf.0.items.[INDEX].validation_type","typeLabel":"enum\u003cinteger>"},"match_failure_type":{"type":"integer","enum":[0,1,2,3],"description":"Behavior on match failure per NOTIFY_TYPES_V4. 0–3 accepted.\n","example":1,"isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].authentication.oneOf.0.items.[INDEX].match_failure_type","typeLabel":"enum\u003cinteger>"},"value_format":{"type":"string","maxLength":250,"description":"Mask format string defining how the value is displayed to the party.\n","example":"XXXX","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].authentication.oneOf.0.items.[INDEX].value_format","typeLabel":"string"},"client_provided_value":{"type":"string","minLength":1,"maxLength":100,"description":"The actual value the party must match to authenticate.\n","example":"1234","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].authentication.oneOf.0.items.[INDEX].client_provided_value","typeLabel":"string"}},"uniqueKey":"transaction_parties.items.[INDEX].authentication.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transaction_parties.items.[INDEX].authentication.oneOf.0","typeLabel":"object[]"},{"type":"null","minItems":1,"description":"Array of authentication challenge records for this party. Maximum count determined by client configuration (`max_authentication_records`).\n","items":{"type":"object","required":["field_label","field_order","validation_type","match_failure_type","value_format","client_provided_value"],"properties":{"field_label":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[A-Za-z0-9\\-\\/ ]+$","description":"Display label for the authentication field. Accepts letters, numbers, hyphens, forward slashes, and spaces.\n","example":"Last 4 SSN"},"field_order":{"type":"integer","minimum":1,"maximum":99,"description":"Display order for the authentication field. Must be unique within the array.\n","example":1},"validation_type":{"type":"integer","enum":[0,1,2,3],"description":"Validation behavior type per NOTIFY_TYPES_V4. 0–3 accepted.\n","example":1},"match_failure_type":{"type":"integer","enum":[0,1,2,3],"description":"Behavior on match failure per NOTIFY_TYPES_V4. 0–3 accepted.\n","example":1},"value_format":{"type":"string","maxLength":250,"description":"Mask format string defining how the value is displayed to the party.\n","example":"XXXX"},"client_provided_value":{"type":"string","minLength":1,"maxLength":100,"description":"The actual value the party must match to authenticate.\n","example":"1234"}}},"uniqueKey":"transaction_parties.items.[INDEX].authentication.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction_parties.items.[INDEX].authentication","typeLabel":"object[] | null"},"notification":{"oneOf":[{"type":"array","minItems":1,"description":"Array of supplemental notification records for this party. Maximum count determined by client configuration (`max_notification_records`).\n","items":{"type":"object","properties":{"field_label":{"type":"string","minLength":1,"maxLength":50,"description":"Display label for the notification record.","example":"Account","uniqueKey":"transaction_parties.items.[INDEX].notification.oneOf.0.items.[INDEX].field_label","typeLabel":"string"},"client_provided_value":{"type":"string","minLength":1,"maxLength":750,"description":"Value to display for this notification record.","example":"Checking Account ending 5678","uniqueKey":"transaction_parties.items.[INDEX].notification.oneOf.0.items.[INDEX].client_provided_value","typeLabel":"string"}},"uniqueKey":"transaction_parties.items.[INDEX].notification.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transaction_parties.items.[INDEX].notification.oneOf.0","typeLabel":"object[]"},{"type":"null","minItems":1,"description":"Array of supplemental notification records for this party. Maximum count determined by client configuration (`max_notification_records`).\n","items":{"type":"object","properties":{"field_label":{"type":"string","minLength":1,"maxLength":50,"description":"Display label for the notification record.","example":"Account"},"client_provided_value":{"type":"string","minLength":1,"maxLength":750,"description":"Value to display for this notification record.","example":"Checking Account ending 5678"}}},"uniqueKey":"transaction_parties.items.[INDEX].notification.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction_parties.items.[INDEX].notification","typeLabel":"object[] | null"},"check_disbursement":{"type":"object","description":"Check disbursement data for this party, used when the disbursement is fulfilled by check. Conditional - required for check-enabled clients unless the party has recipient_enabled of 0.","required":["check_delivery"],"properties":{"check_delivery":{"type":"object","description":"Check delivery information, the payee lines and mailing address used to print and mail the check.","required":["pay_to","address"],"properties":{"pay_to":{"type":"object","required":["pay_to_line_1"],"properties":{"pay_to_line_1":{"type":"string","maxLength":75,"description":"Primary pay-to line printed on the check.","example":"Johnny Rockets","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery.pay_to.pay_to_line_1","typeLabel":"string"},"pay_to_line_2":{"oneOf":[{"type":"string","maxLength":75,"description":"Optional secondary pay-to line.","example":null,"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery.pay_to.pay_to_line_2.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":75,"description":"Optional secondary pay-to line.","example":null,"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery.pay_to.pay_to_line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery.pay_to.pay_to_line_2","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery.pay_to","typeLabel":"object"},"address":{"type":"object","required":["address1","city","state","zip"],"properties":{"address1":{"type":"string","maxLength":40,"description":"Mailing address line 1.","example":"123 Main St.","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery.address.address1","typeLabel":"string"},"city":{"type":"string","maxLength":24,"description":"Mailing city.","example":"Atlanta","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery.address.city","typeLabel":"string"},"state":{"type":"string","minLength":2,"maxLength":2,"description":"Mailing state (standard US postal abbreviation).","example":"GA","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery.address.state","typeLabel":"string"},"zip":{"type":"string","maxLength":10,"pattern":"^[0-9]{5}(?:-[0-9]{4})?$","description":"Mailing zip code.","example":"30313","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery.address.zip","typeLabel":"string"},"address2":{"oneOf":[{"type":"string","maxLength":40,"description":"Optional mailing address line 2.","example":"Apt 3","uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery.address.address2.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":40,"description":"Optional mailing address line 2.","example":"Apt 3","uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery.address.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery.address.address2","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery.address","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_delivery","typeLabel":"object"},"check_memo_stub":{"type":"object","description":"Information printed on the check memo line and stub in the event of a check disbursement.","required":["memo_line"],"properties":{"memo_line":{"type":"string","description":"Text printed on the memo line of the check. Maximum length is validated per the check provider configured for the client.","example":"Claim 00123 settlement","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_memo_stub.memo_line","typeLabel":"string"},"stub_lines":{"oneOf":[{"type":"array","description":"Optional freeform lines printed on the check stub to convey remittance or posting detail to the payee.","items":{"type":"object","required":["text","order"],"properties":{"text":{"type":"string","maxLength":193,"description":"Freeform stub line text. Maximum length is validated per the check provider.","example":"Policy 4456 - March payment","isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_memo_stub.stub_lines.oneOf.0.items.[INDEX].text","typeLabel":"string"},"order":{"type":"integer","description":"Order in which this stub line is printed relative to other stub lines. Must be unique within the array.","example":1,"isRequired":true,"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_memo_stub.stub_lines.oneOf.0.items.[INDEX].order","typeLabel":"integer"}},"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_memo_stub.stub_lines.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_memo_stub.stub_lines.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Optional freeform lines printed on the check stub to convey remittance or posting detail to the payee.","items":{"type":"object","required":["text","order"],"properties":{"text":{"type":"string","maxLength":193,"description":"Freeform stub line text. Maximum length is validated per the check provider.","example":"Policy 4456 - March payment"},"order":{"type":"integer","description":"Order in which this stub line is printed relative to other stub lines. Must be unique within the array.","example":1}}},"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_memo_stub.stub_lines.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_memo_stub.stub_lines","typeLabel":"object[] | null"}},"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement.check_memo_stub","typeLabel":"object"}},"uniqueKey":"transaction_parties.items.[INDEX].check_disbursement","typeLabel":"object"}},"uniqueKey":"transaction_parties.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"transaction_parties","typeLabel":"object[]"},"ledger":{"type":"object","description":"Ledger program information. Required for clients configured for ledgering as a product; exclude entirely if not applicable to your integration.","required":["api_key","user_id","entity_type","entity_id"],"properties":{"api_key":{"type":"string","minLength":1,"maxLength":100,"description":"API key associated with the ledger program.","isRequired":true,"uniqueKey":"ledger.api_key","typeLabel":"string"},"user_id":{"type":"string","minLength":1,"maxLength":100,"description":"User ID associated with the ledger program.","isRequired":true,"uniqueKey":"ledger.user_id","typeLabel":"string"},"entity_type":{"type":"string","maxLength":50,"enum":["business","user"],"description":"Entity type for the ledger. The combination of entity type and entity ID must be valid within the client's program.","isRequired":true,"uniqueKey":"ledger.entity_type","typeLabel":"enum\u003cstring>"},"entity_id":{"type":"string","maxLength":100,"description":"Entity ID associated with the ledger. The combination of entity type and entity ID must be valid within the client's program.","isRequired":true,"uniqueKey":"ledger.entity_id","typeLabel":"string"}},"uniqueKey":"ledger","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"request":{"participant_id":12345,"timestamp":1745356800},"transaction":{"transaction_amount":{"amount":250,"currency_code":"USD"},"participant_unique_ids":{"participant_unique_id1":"a4f1b2c3-d456-789e-f012-34567890abcd","participant_unique_id2":"b5e2c3d4-e567-890f-a123-456789012345"},"workflow_id":1,"notify_type":0,"sender":{"name_personal":{"first_name":"Alex","last_name":"Rivera"},"contact_address":{"address1":"100 Innovation Way","city":"Anytown","state":"GA","zip":"00000"},"contact_telcom":{"email":"noreply@example.com"},"sender_account":"sender-acct-001"}},"transaction_parties":[{"settings":{"client_provided_id":"party-001","role":0,"classification":1,"recipient_enabled":1},"name_personal":{"first_name":"Alex","last_name":"Rivera"},"contact_telcom":{"email":"johnny.rockets@example.com","phone_mobile":"5555550100"},"contact_address":{"address1":"100 Innovation Way","address2":"","city":"Anytown","state":"GA","zip":"00000"},"authentication":[{"field_label":"Last 4 SSN","field_order":1,"validation_type":1,"match_failure_type":1,"value_format":"XXXX","client_provided_value":"1234"}],"notification":[{"field_label":"Account","client_provided_value":"Checking Account ending 5678"}]}]},"examples":{"Example":{"title":"Example","value":{"request":{"participant_id":12345,"timestamp":1745356800},"transaction":{"transaction_amount":{"amount":250,"currency_code":"USD"},"participant_unique_ids":{"participant_unique_id1":"a4f1b2c3-d456-789e-f012-34567890abcd","participant_unique_id2":"b5e2c3d4-e567-890f-a123-456789012345"},"workflow_id":1,"notify_type":0,"sender":{"name_personal":{"first_name":"Alex","last_name":"Rivera"},"contact_address":{"address1":"100 Innovation Way","city":"Anytown","state":"GA","zip":"00000"},"contact_telcom":{"email":"noreply@example.com"},"sender_account":"sender-acct-001"}},"transaction_parties":[{"settings":{"client_provided_id":"party-001","role":0,"classification":1,"recipient_enabled":1},"name_personal":{"first_name":"Alex","last_name":"Rivera"},"contact_telcom":{"email":"johnny.rockets@example.com","phone_mobile":"5555550100"},"contact_address":{"address1":"100 Innovation Way","address2":"","city":"Anytown","state":"GA","zip":"00000"},"authentication":[{"field_label":"Last 4 SSN","field_order":1,"validation_type":1,"match_failure_type":1,"value_format":"XXXX","client_provided_value":"1234"}],"notification":[{"field_label":"Account","client_provided_value":"Checking Account ending 5678"}]}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"cbe3556a-f7e3-413d-a816-b4b7939337c2":{"description":"Notification submitted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","description":"Echo of the request envelope.","properties":{"participant_id":{"type":"integer","example":12345,"uniqueKey":"request.participant_id","typeLabel":"integer"},"timestamp":{"type":"integer","example":1745356800,"uniqueKey":"request.timestamp","typeLabel":"integer"}},"uniqueKey":"request","typeLabel":"object"},"response":{"type":"object","properties":{"status":{"type":"string","description":"Numeric code describing the status of the API request. 100 = Success.\n","example":"100","uniqueKey":"response.status","typeLabel":"string"},"message":{"type":"string","description":"Text description associated with the status code.","example":"Success","uniqueKey":"response.message","typeLabel":"string"},"duration":{"type":"string","description":"Time in seconds to complete the request.","example":"0","uniqueKey":"response.duration","typeLabel":"string"}},"uniqueKey":"response","typeLabel":"object"},"transaction":{"type":"object","description":"Transaction outcome data.","properties":{"participant_unique_ids":{"type":"object","properties":{"participant_unique_id1":{"type":"string","description":"Echo of participant_unique_id1 from request.","example":"a4f1b2c3-d456-789e-f012-34567890abcd","uniqueKey":"transaction.participant_unique_ids.participant_unique_id1","typeLabel":"string"},"participant_unique_id2":{"oneOf":[{"type":"string","description":"Echo of participant_unique_id2 from request.","example":"b5e2c3d4-e567-890f-a123-456789012345","uniqueKey":"transaction.participant_unique_ids.participant_unique_id2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Echo of participant_unique_id2 from request.","example":"b5e2c3d4-e567-890f-a123-456789012345","uniqueKey":"transaction.participant_unique_ids.participant_unique_id2.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction.participant_unique_ids.participant_unique_id2","typeLabel":"string | null"}},"uniqueKey":"transaction.participant_unique_ids","typeLabel":"object"},"notification_id":{"type":"string","description":"Ingo assigned unique identifier for the staged disbursement. Retain this value — it can be used in cancel operations via `POST /gateway/v3/notifycancel`.\n","example":"9876543","uniqueKey":"transaction.notification_id","typeLabel":"string"},"tracer_id":{"type":"string","description":"Ingo assigned tracer ID for the notification.","example":"trc-20260422-001","uniqueKey":"transaction.tracer_id","typeLabel":"string"},"parties":{"type":"array","description":"Party identifiers assigned by Ingo for each party submitted.","items":{"type":"object","properties":{"client_provided_id":{"type":"string","description":"Echo of `client_provided_id` from request.","example":"party-001","uniqueKey":"transaction.parties.items.[INDEX].client_provided_id","typeLabel":"string"},"party_id":{"type":"string","description":"Ingo assigned party ID for this party.","example":"1","uniqueKey":"transaction.parties.items.[INDEX].party_id","typeLabel":"string"}},"uniqueKey":"transaction.parties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transaction.parties","typeLabel":"object[]"}},"uniqueKey":"transaction","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"request":{"participant_id":12345,"timestamp":1745356800},"response":{"status":"100","message":"Success","duration":"0"},"transaction":{"participant_unique_ids":{"participant_unique_id1":"a4f1b2c3-d456-789e-f012-34567890abcd","participant_unique_id2":"b5e2c3d4-e567-890f-a123-456789012345"},"notification_id":"9876543","tracer_id":"trc-20260422-001","parties":[{"client_provided_id":"party-001","party_id":"1"}]}},"examples":{"Example":{"title":"Example","value":{"request":{"participant_id":12345,"timestamp":1745356800},"response":{"status":"100","message":"Success","duration":"0"},"transaction":{"participant_unique_ids":{"participant_unique_id1":"a4f1b2c3-d456-789e-f012-34567890abcd","participant_unique_id2":"b5e2c3d4-e567-890f-a123-456789012345"},"notification_id":"9876543","tracer_id":"trc-20260422-001","parties":[{"client_provided_id":"party-001","party_id":"1"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"129c89fe-000b-42b6-80a2-7b00116c0ae4":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","properties":{"participant_id":{"type":"integer","example":12345,"uniqueKey":"request.participant_id","typeLabel":"integer"},"timestamp":{"type":"integer","example":1745356800,"uniqueKey":"request.timestamp","typeLabel":"integer"}},"uniqueKey":"request","typeLabel":"object"},"response":{"type":"object","properties":{"status":{"type":"string","example":"400","uniqueKey":"response.status","typeLabel":"string"},"message":{"type":"string","example":"Validation Error","uniqueKey":"response.message","typeLabel":"string"}},"uniqueKey":"response","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"request":{"participant_id":12345,"timestamp":1745356800},"response":{"status":"400","message":"Validation Error"}},"examples":{"Example":{"title":"Example","value":{"request":{"participant_id":12345,"timestamp":1745356800},"response":{"status":"400","message":"Validation Error"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"6bbf8852-8ef0-4a60-9df5-0eb859f54fde":{"HmacAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"HMAC-SHA512 signed Authorization header. See the Authentication page for the complete signing guide.","scopes":[]}}},"servers":{"37d4af47-30c4-497a-b4a6-e14b95f4b864":{"url":"https://payapi-sandbox.ingo.money","description":"Sandbox"},"8f91c894-20b3-425b-9b4b-3e7b6f246fa0":{"url":"https://payapi.ingo.money","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"HMAC-SHA512 signed Authorization header. See the Authentication page for the complete signing guide.","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"HMAC-SHA512 signed Authorization header. See the Authentication page for the complete signing guide.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"HmacAuth","name":"Authorization"}],"title":"HmacAuth"}]},"originalFileLocation":"specs/ingopay-notify-v4.yaml"},"subdomain":"ingopayments","siteName":"Ingo Payments Developer Hub","title":"Stage Disbursement - Ingo Payments Developer Hub","contextualStarterQuestions":[{"_id":"69f1321320d5d5d066b6f790","deploymentId":"69de7f66155c3ba96bc71012","questionText":"What parties can be involved?","status":"active","generatedBy":"contextual","path":"docs/notify-managed/notify/stage","createdAt":"2026-04-28T22:17:55.535Z","updatedAt":"2026-04-28T22:17:55.535Z","__v":0},{"_id":"69f1321320d5d5d066b6f791","deploymentId":"69de7f66155c3ba96bc71012","questionText":"How does Notify v4 work here?","status":"active","generatedBy":"contextual","path":"docs/notify-managed/notify/stage","createdAt":"2026-04-28T22:17:55.535Z","updatedAt":"2026-04-28T22:17:55.535Z","__v":0},{"_id":"69f1321320d5d5d066b6f78f","deploymentId":"69de7f66155c3ba96bc71012","questionText":"How do I stage a disbursement?","status":"active","generatedBy":"contextual","path":"docs/notify-managed/notify/stage","createdAt":"2026-04-28T22:17:55.535Z","updatedAt":"2026-04-28T22:17:55.535Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-28T22:17:29.871Z","originalFileLocation":"docs/notify-managed/notify/stage.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=\"dark\"}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=\"Stage a disbursement with one or more parties via Notify v4.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ingo Payments Developer Hub\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Stage Disbursement - Ingo Payments Developer Hub\">\u003cmeta data-mint-head property=\"og:description\" content=\"Stage a disbursement with one or more parties via Notify v4.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ingo Payments Developer Hub\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.ingopayments.com/docs/notify-managed/notify/stage\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ingopayments.mintlify.app/_mintlify/api/og/v2?division=Notify\u0026amp;title=Stage+Disbursement\u0026amp;description=Stage+a+disbursement+with+one+or+more+parties+via+Notify+v4.\u0026amp;theme=ffb6732ea583e2d7404edaa7\u0026amp;signature=7bfd65d398cab494322c4360e39cbf032524b41fcb8cc1c7045a992a4720278a\">\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=\"Stage Disbursement - Ingo Payments Developer Hub\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Stage a disbursement with one or more parties via Notify v4.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ingopayments.mintlify.app/_mintlify/api/og/v2?division=Notify\u0026amp;title=Stage+Disbursement\u0026amp;description=Stage+a+disbursement+with+one+or+more+parties+via+Notify+v4.\u0026amp;theme=ffb6732ea583e2d7404edaa7\u0026amp;signature=7bfd65d398cab494322c4360e39cbf032524b41fcb8cc1c7045a992a4720278a\">\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/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ingo Payments Developer Hub\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#23ad4b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.ingopayments.com/docs/notify-managed/notify/stage\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/notify-managed/notify/stage.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.ingopayments.com/#organization\",\"name\":\"Ingo Payments Developer Hub\",\"url\":\"https://developers.ingopayments.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ingopayments/iShoHhbLzbG-YOtN/logo/light.svg?fit=max\u0026auto=format\u0026n=iShoHhbLzbG-YOtN\u0026q=85\u0026s=556c65165f3a5daf3e33eaf145664046\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.ingopayments.com#website\",\"name\":\"Ingo Payments Developer Hub\",\"url\":\"https://developers.ingopayments.com\",\"publisher\":{\"@id\":\"https://developers.ingopayments.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.ingopayments.com/docs/notify-managed/notify/stage#webpage\",\"url\":\"https://developers.ingopayments.com/docs/notify-managed/notify/stage\",\"name\":\"Stage Disbursement\",\"description\":\"Stage a disbursement with one or more parties via Notify v4.\",\"dateModified\":\"2026-04-28T22:17:29.871Z\",\"isPartOf\":{\"@id\":\"https://developers.ingopayments.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.ingopayments.com/docs/notify-managed/notify/stage#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.ingopayments.com/docs/notify-managed/notify/stage#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Ingo Payments Developer Hub\",\"item\":\"https://developers.ingopayments.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Stage Disbursement\",\"item\":\"https://developers.ingopayments.com/docs/notify-managed/notify/stage\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.ingopayments.com/docs/notify-managed/notify/stage#apireference\",\"headline\":\"Stage Disbursement\",\"name\":\"Stage Disbursement\",\"description\":\"Stage a disbursement with one or more parties via Notify v4.\",\"url\":\"https://developers.ingopayments.com/docs/notify-managed/notify/stage\",\"mainEntityOfPage\":{\"@id\":\"https://developers.ingopayments.com/docs/notify-managed/notify/stage#webpage\"},\"dateModified\":\"2026-04-28T22:17:29.871Z\",\"publisher\":{\"@id\":\"https://developers.ingopayments.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.ingopayments.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ingo Payments Developer Hub\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ingo Payments Developer Hub","nav":{"global":{},"tabs":[{"tab":"Hub","pages":[{"title":"Hub","href":"/docs/hub/overview"}]},{"tab":"IngoPay API","pages":[{"title":"IngoPay API","href":"/docs/ingopay/overview"}]},{"tab":"Embedded Account Capture","pages":[{"title":"Embedded Account Capture","href":"/docs/iframe/overview"}]},{"tab":"Notify — Classic","pages":[{"title":"Notify — Classic","href":"/docs/notify-classic/overview"}]},{"tab":"Notify — Managed Parties","groups":[{"group":"Overview","pages":[{"title":"Notify — Managed Parties","mode":"wide","href":"/docs/notify-managed/overview"},{"title":"Quick Start","href":"/docs/notify-managed/quick-start"},{"title":"Notification Types","href":"/docs/notify-managed/notification-types"},{"title":"Testing","href":"/docs/notify-managed/testing"},{"title":"Repeat Recipient","href":"/docs/hub/repeat-recipient"},{"title":"Notification Records","href":"/docs/hub/notification-records"},{"title":"Embedded Documents","href":"/docs/hub/embedded-documents"},{"title":"Single Sign-On","description":"Hand an already-authenticated customer from your portal directly into the Digital Payment Center with a signed redirect — bypassing the recipient authentication challenge. Available for Notify — Classic and Notify — Managed Parties.","href":"/docs/hub/single-sign-on"}]},{"group":"Notify","pages":[{"title":"Stage Disbursement","openapi":"specs/ingopay-notify-v4.yaml POST /gateway/v4/notify","href":"/docs/notify-managed/notify/stage"},{"title":"Cancel Disbursement","description":"Cancel a staged Notify — Managed Parties disbursement that has not yet been claimed by the recipient.","openapi":"specs/ingopay-notify-v3.yaml POST /gateway/v3/notifycancel","href":"/docs/notify-managed/notify/cancel"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Overview","href":"/docs/notify-managed/webhooks/overview"},{"group":"Webhooks","pages":[{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionStagingStatusSuccess","href":"/notify-managed-webhooks/webhooks/disbursement-staged","title":"Disbursement Staged","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionPartyNotificationStatusSent","href":"/notify-managed-webhooks/webhooks/party-notification-sent","title":"Party Notification Sent","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionPartyNotificationStatusReceived","href":"/notify-managed-webhooks/webhooks/party-notification-received","title":"Party Notification Received","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionPartyNotificationStatusBounced","href":"/notify-managed-webhooks/webhooks/party-notification-bounced","title":"Party Notification Bounced","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionPartyAuthenticationDynamicValidationSuccess","href":"/notify-managed-webhooks/webhooks/dynamic-validation-success","title":"Dynamic Validation Success","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionPartyAuthenticationDynamicValidationFailure","href":"/notify-managed-webhooks/webhooks/dynamic-validation-failure","title":"Dynamic Validation Failure","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionPartyAuthenticationOtacDeliveryGenerate","href":"/notify-managed-webhooks/webhooks/otac-delivery-generated","title":"OTAC Delivery Generated","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionPartyAuthenticationOtacDeliveryLimit","href":"/notify-managed-webhooks/webhooks/otac-delivery-limit-reached","title":"OTAC Delivery Limit Reached","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionPartyAuthenticationOtacValidationSuccess","href":"/notify-managed-webhooks/webhooks/otac-validation-success","title":"OTAC Validation Success","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionPartyAuthenticationOtacValidationFailure","href":"/notify-managed-webhooks/webhooks/otac-validation-failure","title":"OTAC Validation Failure","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionPartyAuthenticationOverallSuccess","href":"/notify-managed-webhooks/webhooks/overall-authentication-passed","title":"Overall Authentication Passed","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionPartyAuthenticationOverallFailure","href":"/notify-managed-webhooks/webhooks/overall-authentication-failed","title":"Overall Authentication Failed","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientVerificationRvdmSuccess","href":"/notify-managed-webhooks/webhooks/rvdm-verification-success","title":"RVDM Verification Success","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientVerificationRvdmFailure","href":"/notify-managed-webhooks/webhooks/rvdm-verification-failure","title":"RVDM Verification Failure","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientVerificationOfacStatusSuspended","href":"/notify-managed-webhooks/webhooks/ofac-suspended","title":"OFAC Suspended","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientVerificationOfacStatusCleared","href":"/notify-managed-webhooks/webhooks/ofac-cleared","title":"OFAC Cleared","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientVerificationOfacStatusFailure","href":"/notify-managed-webhooks/webhooks/ofac-failure","title":"OFAC Failure","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionAccountVerificationCardFailureCnsCd","href":"/notify-managed-webhooks/webhooks/card-cnscd-verification-failure","title":"Card CNS/CD Verification Failure","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionAccountVerificationCardFailureAvsCvv","href":"/notify-managed-webhooks/webhooks/card-avscvv-verification-failure","title":"Card AVS/CVV Verification Failure","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionAccountVerificationAchFailureRnv","href":"/notify-managed-webhooks/webhooks/ach-routing-number-verification-failure","title":"ACH Routing Number Verification Failure","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionAccountVerificationAchFailureAnv","href":"/notify-managed-webhooks/webhooks/ach-account-number-verification-failure","title":"ACH Account Number Verification Failure","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionAccountVerificationAchFailureNav","href":"/notify-managed-webhooks/webhooks/ach-nameaddress-verification-failure","title":"ACH Name/Address Verification Failure","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionAccountVerificationPaypalSuccessAv","href":"/notify-managed-webhooks/webhooks/paypal-account-verification-success","title":"PayPal Account Verification Success","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionAccountVerificationPaypalFailureAv","href":"/notify-managed-webhooks/webhooks/paypal-account-verification-failure","title":"PayPal Account Verification Failure","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionAccountTokenizationSuccess","href":"/notify-managed-webhooks/webhooks/account-tokenization-success","title":"Account Tokenization Success","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentDisbursementRequestExpired","href":"/notify-managed-webhooks/webhooks/disbursement-request-expired","title":"Disbursement Request Expired","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentDisbursementRequestCanceled","href":"/notify-managed-webhooks/webhooks/disbursement-request-canceled","title":"Disbursement Request Canceled","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusFailure","href":"/notify-managed-webhooks/webhooks/payment-failed","title":"Payment Failed","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusCheck","href":"/notify-managed-webhooks/webhooks/check-in-process","title":"Check In Process","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusCheckIssued","href":"/notify-managed-webhooks/webhooks/check-issued","title":"Check Issued","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusCheckPaid","href":"/notify-managed-webhooks/webhooks/check-paid","title":"Check Paid","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusCheckCanceled","href":"/notify-managed-webhooks/webhooks/check-canceled","title":"Check Canceled","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusCheckStopped","href":"/notify-managed-webhooks/webhooks/check-stopped","title":"Check Stopped","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusCheckReturned","href":"/notify-managed-webhooks/webhooks/check-returned","title":"Check Returned","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusSuccess","href":"/notify-managed-webhooks/webhooks/payment-successful","title":"Payment Successful","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusTerminated","href":"/notify-managed-webhooks/webhooks/payment-terminated","title":"Payment Terminated","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusReturned","href":"/notify-managed-webhooks/webhooks/payment-returned","title":"Payment Returned","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentNoticeStatusRecipientCancel","href":"/notify-managed-webhooks/webhooks/recipient-canceled","title":"Recipient Canceled","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentNoticeSettlementAdjustment","href":"/notify-managed-webhooks/webhooks/settlement-adjustment","title":"Settlement Adjustment","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentNoticeAchNocV1","href":"/notify-managed-webhooks/webhooks/ach-notice-of-change","title":"ACH Notice of Change","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusApprovalsPmtSuspended","href":"/notify-managed-webhooks/webhooks/approvals-—-payment-suspended","title":"Approvals — Payment Suspended","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusApprovalsDecisionApproved","href":"/notify-managed-webhooks/webhooks/approval-decision-—-approved","title":"Approval Decision — Approved","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusApprovalsDecisionDeclined","href":"/notify-managed-webhooks/webhooks/approval-decision-—-declined","title":"Approval Decision — Declined","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusApprovalsComplete","href":"/notify-managed-webhooks/webhooks/approvals-complete","title":"Approvals Complete","version":null},{"asyncapi":"specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentStatusRolesChange","href":"/notify-managed-webhooks/webhooks/party-role-change","title":"Party Role Change","version":null}]}]}]},{"tab":"Banking Platform","pages":[{"title":"Banking Platform","href":"/docs/banking/overview"}]},{"tab":"Check Risk Management Services","hidden":true,"pages":[{"title":"Check Risk Management Services","href":"/docs/crms/overview"}]}]},"title":"Stage Disbursement - Ingo Payments Developer Hub","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CBCH2P7b.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}