OBJECT

PayoutOnboardingWorkflow

PayoutOnboardingWorkflow describes the workflow details while a user is onboarding into a payout program.

link GraphQL Schema definition

1type PayoutOnboardingWorkflow {
2
3# The current step at which this workflow is at.
4currentStep: PayoutOnboardingStep!
5
6# A PayoutOnboardingWorkflow's unique ID.
7id: ID!
8
9# The URL for a user to update their payout settings. A redirectURL is the URL
10# where the user will be redirected to after updating their payout settings.
11payoutSettingsURL(redirectURL: String): String!
12
13# The registration information submitted by the user for this workflow.
14registration: PayoutRegistration
15
16# Describes a user's tax interview information while completing their payout
17# onboarding.
18taxInterview(type: TaxInterviewType!, returnURL: String!): TaxInterview
19
20# Lists the fields that were mismatched during the registration and tax interview
21# steps.
22taxMismatchErrors: [TaxMismatchError!]
23
24# The timestamp when the workflow was most recently updated.
25timestamp: Time!
26
27}