Documentation
¶
Overview ¶
Package transfer records that a payable was PAID — the annotation a human writes after paying out-of-band. Commerce executes no payout; a Transfer is a fact about one that already happened.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Transfer ¶
type Transfer struct {
mixin.Model[Transfer]
// FeeId is the payable this settles; PayeeId is who was paid.
FeeId string `json:"feeId"`
PayeeId string `json:"payeeId,omitempty"`
// Settles is how much of the payable this clears, in the payable's asset.
// Sent is what actually left, in whatever asset it left in — the two differ
// when a dollar-denominated payable is paid in ETH.
Settles currency.Money `json:"settles"`
Sent currency.Money `json:"sent,omitempty"`
// (Type, Reference) names one real-world payment, so recording it twice
// settles once.
Type Type `json:"type"`
Reference string `json:"reference,omitempty"`
PaidAt time.Time `json:"paidAt,omitempty"`
Actor string `json:"actor,omitempty"`
Note string `json:"note,omitempty"`
}
Transfer is one payment against one payable.
Click to show internal directories.
Click to hide internal directories.