refund

package

v1.34.0 Latest Latest Go to latest Published: Feb 23, 2026 License: MIT Imports: 3 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 Refund
- func New(db *datastore.Datastore) *Refund
type Status

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Query ¶

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

Types ¶

type Refund ¶

type Refund struct {
	mixin.Model

	Amount          int64                  `json:"amount"`
	Currency        currency.Type          `json:"currency"`
	Status          Status                 `json:"status"`
	ProviderRef     string                 `json:"providerRef"`
	Reason          string                 `json:"reason,omitempty"`
	ReceiptNumber   string                 `json:"receiptNumber,omitempty"`
	FailureReason   string                 `json:"failureReason,omitempty"`
	PaymentIntentId string                 `json:"paymentIntentId,omitempty"`
	InvoiceId       string                 `json:"invoiceId,omitempty"`
	Metadata        map[string]interface{} `json:"metadata,omitempty"`
}

Refund represents a reversal of a previous payment.

func New ¶

func New(db *datastore.Datastore) *Refund

func (*Refund) Defaults ¶

func (r *Refund) Defaults()

func (*Refund) Init ¶

func (r *Refund) Init(db *datastore.Datastore)

func (Refund) Kind ¶

func (r Refund) Kind() string

func (*Refund) MarkFailed ¶

func (r *Refund) MarkFailed(reason string) error

MarkFailed transitions the refund to Failed with a reason.

func (*Refund) MarkSucceeded ¶

func (r *Refund) MarkSucceeded() error

MarkSucceeded transitions the refund to Succeeded.

type Status ¶

type Status string

Status represents the state of a refund.

const (
	Pending   Status = "pending"
	Succeeded Status = "succeeded"
	Failed    Status = "failed"
	Canceled  Status = "canceled"
)

Source Files ¶

View all Source files

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