AccountRequirements

Information or documents Paypercut needs before an account or requested capability can be fully enabled. Requirement arrays contain field paths that identify what must be provided or verified.

Prioritize past_due and currently_due. Use eventually_due to collect information before it becomes mandatory, and wait for fields in pending_verification to finish verification. When a submitted value is rejected, errors explains which requirement must be corrected.

  • current_deadline
    Type: string | nullFormat: date-time

    Date by which the fields in currently_due must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.

  • currently_due
    Type: array of string | null
    max length:  
    5000

    Fields that need to be collected to keep the account enabled. If not collected by current_deadline, these fields appear in past_due as well, and the account is disabled.

  • disabled_reason
    Type: string | nullenum

    If the account is disabled, this enum describes why.

    values
    • action_required.requested_capabilities
    • listed
    • other
    • platform_paused
    • rejected.fraud
    • rejected.incomplete_verification
    • rejected.listed
    • rejected.other
  • errors
    Type: array of AccountRequirementsError | null

    Fields that are currently_due and need to be collected again because validation or verification failed.

    Properties: 3
  • eventually_due
    Type: array of string | null
    max length:  
    5000

    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and current_deadline becomes set.

  • past_due
    Type: array of string | null
    max length:  
    5000

    Fields that weren't collected by current_deadline. These fields need to be collected to enable the account.

  • pending_verification
    Type: array of string | null
    max length:  
    5000

    Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to eventually_due, currently_due, or past_due. Fields might appear in eventually_due, currently_due, or past_due and in pending_verification if verification fails but another verification is still pending.