TheDocumentation Index
Fetch the complete documentation index at: https://developers.ingopayments.com/llms.txt
Use this file to discover all available pages before exploring further.
notify_type field in the v4 stage request controls the lifecycle mode of the notification. It determines whether the staged event triggers a disbursement, an enrollment experience, or both — and whether the recipient is new to the platform or already enrolled from a prior interaction.
Selecting the right notification type is the primary architectural decision for programs that intend to support recurring payments or standalone account capture.
Type 0 — Standard Disbursement
Available now. This is the only notification type currently available for integration.
Type 1 — Enrollment Only
In Development — Not yet available for integration
Collect a recipient’s payment preferences without staging a disbursement. The fully hosted experience presents your configured payment options through the Embedded Account Capture interface. On completion, Ingo returns a customer_account_token tied to the recipient’s chosen account — no disbursement is triggered. The token can then be used with notify_type: 2 for any number of future disbursements without repeating the enrollment experience.
Use when: You want to onboard recipients proactively — collecting payment preferences before a disbursement event occurs — so payments can be issued immediately when the time comes without putting the recipient through account capture at the point of payment.
Common programs: Earned wage access pre-enrollment, insurance claim pre-authorization, payroll onboarding, recurring benefits programs.
Type 2 — Disbursement Only (Enrolled Party)
In Development — Not yet available for integration
Stage a disbursement against a recipient who is already enrolled. Rather than presenting the full payment selection experience again, Ingo uses the party_id from the prior enrollment to route the payment to the recipient’s established account. The recipient is notified that a payment is on the way without being asked to re-select a payment method.
Use when: You have previously enrolled a recipient via notify_type: 1 or notify_type: 3 and are now issuing a recurring or subsequent payment to the same account.
Requires: A valid party_id from a prior enrollment. Pass this in the settings.party_id field rather than settings.client_provided_id.
Type 3 — Enrollment + Disbursement
In Development — Not yet available for integration
Combines enrollment and disbursement in a single notification. The recipient selects a payment method through the hosted experience and, upon completion, the disbursement is immediately processed to their chosen account. Ingo returns both a customer_account_token and a completed payment — the account is enrolled for future use automatically.
Use when: You want to issue a first-time payment and establish the recipient’s account preferences in a single interaction, so future payments can use notify_type: 2 without a separate enrollment step.
Common programs: First-payment-plus-enrollment flows, benefits onboarding with immediate disbursement, insurance first-claim settlement.