Type alias PayoutMethodBeta

PayoutMethod: {
    description?: string;
    estimatedSettlementTime: number;
    fee?: string;
    group?: string;
    kind: string;
    max?: string;
    min?: string;
    name?: string;
    requiredPaymentDetails?: JsonSchema;
}

The payout method specified by the resource pay in and pay out

Type declaration

  • Optional description?: string

    Blurb containing helpful information about the payment method. Expected to be rendered on screen. e.g. "segwit addresses only"

  • estimatedSettlementTime: number

    estimated time taken to settle an order. expressed in seconds

  • Optional fee?: string

    Fee charged to use this payment method as a decimal string.

  • Optional group?: string

    value that can be used to group specific payment methods together e.g. Mobile Money vs. Direct Bank Deposit

  • kind: string

    The type of payment method. e.g. BITCOIN_ADDRESS, DEBIT_CARD etc

  • Optional max?: string

    maximum amount allowed when using this payment method.

  • Optional min?: string

    minimum amount required to use this payment method.

  • Optional name?: string

    Payment Method name. Expected to be rendered on screen.

  • Optional requiredPaymentDetails?: JsonSchema

    A JSON Schema containing the fields that need to be collected in order to use this payment method

Settings

Member Visibility

Theme