Interface MicrotransactionProvider

interface MicrotransactionProvider {
    account: null | {
        charges_enabled: boolean;
        country: null | string;
        id: string;
        merchant_name?: null | string;
        payouts_enabled: boolean;
        requirements_due: string[];
    };
    available: boolean;
    channels: string[];
    checked_at: null | string;
    configuration: MicrotransactionProviderConfiguration;
    configured: boolean;
    countries: string[];
    currencies: string[];
    enabled: boolean;
    environment: MicrotransactionEnvironment;
    minimum_amounts: Record<string, number>;
    payment_methods: string[];
    payout_account: {
        available: boolean;
        country: null | string;
        id: null | string;
        payouts_enabled: boolean;
        reasons: string[];
        requirements_due: string[];
        source: "managed" | "platform" | "user" | "community";
        transfers_active: boolean;
    };
    priority: number;
    provider: MicrotransactionProviderName;
    reasons: string[];
    revision?: number;
    tax: {
        missing_fields: string[];
        status: string;
    };
    tax_collection?: null | MicrotransactionTaxCollection;
    warnings?: string[];
}

Properties

account available channels checked_at configuration configured countries currencies enabled environment minimum_amounts payment_methods payout_account priority provider reasons revision? tax tax_collection? warnings?

Properties

account

account: null | {
    charges_enabled: boolean;
    country: null | string;
    id: string;
    merchant_name?: null | string;
    payouts_enabled: boolean;
    requirements_due: string[];
}

Type declaration

  • charges_enabled: boolean
  • country: null | string
  • id: string
  • Optional merchant_name?: null | string
  • payouts_enabled: boolean
  • requirements_due: string[]

available

available: boolean

Actual external provider/account capability, not a manual approval flag.

channels

channels: string[]

checked_at

checked_at: null | string

configuration

configuration: MicrotransactionProviderConfiguration

configured

configured: boolean

countries

countries: string[]

currencies

currencies: string[]

enabled

enabled: boolean

environment

environment: MicrotransactionEnvironment

minimum_amounts

minimum_amounts: Record<string, number>

payment_methods

payment_methods: string[]

payout_account

payout_account: {
    available: boolean;
    country: null | string;
    id: null | string;
    payouts_enabled: boolean;
    reasons: string[];
    requirements_due: string[];
    source: "managed" | "platform" | "user" | "community";
    transfers_active: boolean;
}

The game's payout target. Do not substitute the platform processing account's payouts_enabled.

Type declaration

  • available: boolean
  • country: null | string
  • id: null | string
  • payouts_enabled: boolean
  • reasons: string[]
  • requirements_due: string[]
  • source: "managed" | "platform" | "user" | "community"
  • transfers_active: boolean

priority

priority: number

provider

provider: MicrotransactionProviderName

reasons

reasons: string[]

Optional revision

revision?: number

tax

tax: {
    missing_fields: string[];
    status: string;
}

Type declaration

  • missing_fields: string[]
  • status: string

Optional tax_collection

tax_collection?: null | MicrotransactionTaxCollection

Current route facts only. Never use these to reinterpret an existing order's frozen decision.

Optional warnings

warnings?: string[]

Non-blocking collection warnings, separate from reasons and payout_account availability.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc