Preview

transferMethod is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

transferMethod

Retrieve a transfer method by account ID. Returns a StripeTransferMethod if the transfer method exists.

This page contains

    Arguments

    accountId ID!

    The account ID

    platformType String!

    The platform type (e.g., STRIPE)

    partyType String!

    The party type (e.g., COMPANY)

    includeBalance Boolean

    Whether to include the transfer method balance

    returnUrl String

    The URL to redirect the user to after completing onboarding

    refreshUrl String

    The URL to redirect the user to if they need to refresh the onboarding link

    Return Fields

    StripeTransferMethod PREVIEW

    Stripe transfer method implementation. Extends TransferMethod with Stripe-specific fields.

    Interactive example

    This is an example query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.