Skip to main content

vendorPayoutOnboardingLinkRequest

Retrieves an onboarding link for the given vendor from the given gateway if available.

vendorPayoutOnboardingLinkRequest(
gateway: String!
refreshUrl: String!
returnUrl: String!
vendorId: ID!
): VendorPayoutOnboardingLinkRequest

Arguments

vendorPayoutOnboardingLinkRequest.gateway ● String! non-null scalar

Payout gateway to retrieve onboarding link from

vendorPayoutOnboardingLinkRequest.refreshUrl ● String! non-null scalar

Refresh url to route back to when onboarding link needs to be refreshed

vendorPayoutOnboardingLinkRequest.returnUrl ● String! non-null scalar

Return url to route back to after onboarding is completed or interrupted

vendorPayoutOnboardingLinkRequest.vendorId ● ID! non-null scalar

ID of the vendor to retrieve an onboarding link for

Type

VendorPayoutOnboardingLinkRequest object

Retrieves an onboarding link for the given vendor from the given gateway if available.

Was this page helpful?