Magidoc

PayoutMethod
Object

A payout method

Fields

#

id

String !
Non-null

Unique identifier for this payout method

publicId

String !
Non-null

The resource public id (ie: po_xxxxxxxx)

type

PayoutMethodType

The type of this payout method (usually the payment provider)

name

String

A friendly name for users to easily find their payout methods

isSaved

Boolean

Whether this payout method has been saved to be used for future payouts

data

JSON

The actual data for this payout method. Content depends on the type.

canBeEdited

Boolean

Whether this payout method can be edited

canBeDeleted

Boolean

Whether this payout method can be deleted or only archived

canBeArchived

Boolean

Whether this payout method can be archived

isVerified

Boolean

For PayPal payout methods: whether the PayPal account has been verified via OAuth. Null for other types.

createdAt

DateTime !
Non-null

The date and time this payout method was created

updatedAt

DateTime !
Non-null

The date and time this payout method was updated

Usages

#

References

#

  • Field payoutMethods from Host
  • Field payoutMethods from Bot