Interface TipLinkCreateDeets

export TipLinkCreateDeets

interface TipLinkCreateDeets {
    after_payment_message: string;
    contract_id?: null | string;
    description: string;
    image_url?: null | string;
    name: string;
    object?: null | string;
    splits: TipLinkSplitContact[];
}

Properties

after_payment_message contract_id? description image_url? name object? splits

Properties

after_payment_message

after_payment_message: string

AfterPaymentMessage this tip link. This will show when payment complete.

Optionalcontract_id

contract_id?: null | string

A contract for the Tip Link. This is useful for more complex scenarios than simple flat splits.

description

description: string

Description this tip link. This should indicate description about the purpose. This is displayed on the payment page.

Optionalimage_url

image_url?: null | string

ImageUrl this tip link.

name

name: string

Name this tip link. This should indicate something about the purpose. This is displayed on the payment page.

Optionalobject

object?: null | string

splits

splits: TipLinkSplitContact[]

These define simple splits between contacts. When a Tip Link is used, and funds clear, the money will automatically flow to these contacts as though it was coming from the user that owns the tip link.

Settings

Member Visibility

On This Page

Properties