payout

package

v1.35.1 Latest Latest Go to latest Published: Feb 24, 2026 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hanzoai/commerce

Links

Open Source Insights

Documentation ¶

Index ¶

func Query(db *datastore.Datastore) datastore.Query
type Payout
- func New(db *datastore.Datastore) *Payout
type Status

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Query ¶

func Query(db *datastore.Datastore) datastore.Query

Types ¶

type Payout ¶

type Payout struct {
	mixin.BaseModel

	Amount          int64         `json:"amount"` // cents
	Currency        currency.Type `json:"currency"`
	Status          Status        `json:"status"`
	DestinationType string        `json:"destinationType"` // "bank_account" | "card"
	DestinationId   string        `json:"destinationId"`   // payment method ID
	Description     string        `json:"description,omitempty"`
	ArrivalDate     time.Time     `json:"arrivalDate,omitempty"`
	ProviderRef     string        `json:"providerRef,omitempty"`
	FailureCode     string        `json:"failureCode,omitempty"`
	FailureMessage  string        `json:"failureMessage,omitempty"`

	Metadata  Map    `json:"metadata,omitempty" datastore:"-"`
	Metadata_ string `json:"-" datastore:",noindex"`
}

Payout represents an outbound transfer to a bank account or card.

func New ¶

func New(db *datastore.Datastore) *Payout

func (*Payout) Cancel ¶

func (p *Payout) Cancel() error

Cancel transitions payout to canceled.

func (*Payout) Defaults ¶

func (p *Payout) Defaults()

func (*Payout) Init ¶

func (p *Payout) Init(db *datastore.Datastore)

func (Payout) Kind ¶

func (p Payout) Kind() string

func (*Payout) Load ¶

func (p *Payout) Load(ps []datastore.Property) (err error)

func (*Payout) MarkFailed ¶

func (p *Payout) MarkFailed(code, message string) error

MarkFailed transitions payout to failed.

func (*Payout) MarkInTransit ¶

func (p *Payout) MarkInTransit() error

MarkInTransit transitions payout to in-transit.

func (*Payout) MarkPaid ¶

func (p *Payout) MarkPaid() error

MarkPaid transitions payout to paid.

func (*Payout) Save ¶

func (p *Payout) Save() (ps []datastore.Property, err error)

func (*Payout) Validator ¶

func (p *Payout) Validator() *val.Validator

type Status ¶

type Status string

Status represents the payout lifecycle state.

const (
	Pending   Status = "pending"
	InTransit Status = "in_transit"
	Paid      Status = "paid"
	Failed    Status = "failed"
	Canceled  Status = "canceled"
)

Source Files ¶

View all Source files

payout.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL