AccountLinkCreateRequest

Request to create an Account Link for an existing connected account.

  • account
    Type: string
    min length:  
    1
    max length:  
    100
    required

    ID of the existing connected account to onboard.

  • type
    enum
    const:  
    account_onboarding
    required

    Account Link flow to create.

    values
    • account_onboarding

      Collects outstanding requirements through hosted onboarding.

  • refresh_url
    Type: string
    min length:  
    1
    max length:  
    2048    Format: uri
    required

    URL used when the Account Link expires or cannot be used. Your integration must create a new Account Link before redirecting the representative again.

    Use an absolute HTTPS URL without user information or fragments. HTTP is accepted only for loopback hosts during local development.

  • return_url
    Type: string
    min length:  
    1
    max length:  
    2048    Format: uri
    required

    URL used when the hosted interaction ends. Reaching this URL does not mean onboarding or verification is complete.

    Use an absolute HTTPS URL without user information or fragments. HTTP is accepted only for loopback hosts during local development.

  • collection_options
    Type: object · AccountLinkCollectionOptions

    Requirements to collect during hosted onboarding.

    • fields
      Type: string enum

      Account requirement scope to collect.

      values
      • currently_due

        Collects only requirements that are currently due.

      • eventually_due

        Collects current requirements and information that will become due later.

  • locale
    Type: string
    min length:  
    2
    max length:  
    35

    Preferred IETF language tag for hosted onboarding. When omitted, Paypercut uses the Account's default locale when available.

    The locale applies when a new onboarding session is created. An active session resumes with its existing locale.