Vendor Onboarding
A vendor must meet four requirements before receiving an advance.
GET /v1/organizations/{externalId} reports
each one.
| Requirement | Met when |
|---|---|
| Compliance | The vendor's compliance is cleared. |
| Agreement | The agreement is signed. |
| Bank account | A payout account is on file. |
| Collection account | The account the vendor's payors pay into is ready to receive payments. |
The first three can be completed in any order. Lunch normally opens the collection account once they
are met.
Advance requests before all four are met return 409 business_not_eligible.
Collection account: requires only an address, taken from the signed agreement or from contact
in PUT /v1/organizations/{externalId}. Verification usually takes a few minutes. Once open, its
details are returned as remittance on GET /v1/organizations/{externalId} and on every advance
response.
Onboarding a Vendor
Vendors currently onboard by invitation.
- Sync the vendor with
PUT /v1/organizations/{externalId}, or sync one of its invoices. IncludetaxIdif available. - If you have the vendor's bank details, set them with
PUT /v1/organizations/{externalId}/payout-account. - Send
POST /v1/invitationsso the vendor can claim its account and sign the agreement.
The vendor must be synced before it is invited. Unsynced identifiers return 404 business_not_found.
Invitations
Invitations apply only to your relationship with the vendor. Access does not extend to the vendor's relationships with other platforms, and theirs does not extend to yours.
| Behavior | Detail |
|---|---|
| Existing accounts | The person is added to this vendor. No second account is created. |
| Repeat invitations | Reissues the link. Only one link is active at a time. |
| Expiry | Single use. Expires after 30 days. |
Hosted Onboarding
Hosted onboarding is not yet live
POST /v1/onboarding-sessions
returns a single-use link, displayed in your product, where the vendor completes compliance, the
agreement and bank account. Links created today do not resolve. Build against the published shape.
Lunch will announce availability.