paygate

package module

Go to main page

Versions in this module

v0

v0.7.0

Jun 25, 2026

Changes in this version

+ var ErrChargeDeclined = errors.New("paygate: payment method declined")

v0.6.0

Jun 25, 2026

Changes in this version

+ type SaveSetupRequest struct

+ CustomerEmail string

+ CustomerName string

+ Gateway string

+ TenantID uuid.UUID

+ type SaveSetupResult struct

+ ApprovalURL string

+ ClientSecret string

+ CustomerID string

+ Gateway string

+ SetupIntentID string

+ SetupTokenID string

type Service

+ func (s *Service) CreateSaveSetup(ctx context.Context, in SaveSetupRequest) (SaveSetupResult, error)

+ func (s *Service) PersistSavedMethodFromSetup(ctx context.Context, tenantID uuid.UUID, gateway, reference string) error

+ type SetupGateway interface

+ CreateSaveSetup func(ctx context.Context, customerID string, metadata map[string]string) (SaveSetupResult, error)

+ PersistSavedMethodFromSetup func(ctx context.Context, reference string) (SavedMethodDetails, error)

v0.5.0

Jun 8, 2026

Changes in this version

+ const MinTopupCents

+ var ErrAmountTooSmall = errors.New("paygate: amount below minimum")

+ var ErrUnknownGateway = errors.New("paygate: unknown gateway")

v0.4.0

Jun 3, 2026

Changes in this version

+ type DirectChargeInput struct

+ AmountCents int64

+ Description string

+ Metadata map[string]string

+ MethodID uuid.UUID

+ TenantID uuid.UUID

+ TransactionType string

+ type DirectChargeResult struct

+ GatewayTxnID string

+ Succeeded bool

+ TransactionID uuid.UUID

type Service

+ func (s *Service) ChargeSavedMethodDirect(ctx context.Context, in DirectChargeInput) (DirectChargeResult, error)

v0.3.0

May 20, 2026

Changes in this version

+ type CaptureResult struct

+ Completed bool

+ SavedMethod *SavedMethodDetails

+ type SavedMethodDetails struct

+ Card *CardDetails

+ CustomerID string

+ PayPalEmail string

+ PayPalPayerID string

+ PaymentMethodID string

+ PaymentType string

v0.2.0

May 20, 2026

Changes in this version

+ const GatewayPayPal

+ const GatewayStripe

+ var ErrGatewayDisabled = errors.New("paygate: gateway disabled")

+ var ErrGatewayNotFound = errors.New("paygate: gateway not configured")

+ var ErrPaymentMethodNotFound = errors.New("paygate: payment method not found")

+ var ErrTenantNotFound = errors.New("paygate: tenant not found")

+ var ErrTopupNotFound = errors.New("paygate: topup not found")

+ func CentsToAmount(cents int64) string

+ type CapturableGateway interface

+ CaptureTopupPayment func(ctx context.Context, gatewayTxnID string) (completed bool, err error)

+ type CardDetails struct

+ Brand string

+ ExpMonth int

+ ExpYear int

+ Last4 string

+ type CreateTopupInput struct

+ Amount string

+ Description string

+ Gateway string

+ GatewayCustomerID string

+ GatewayTxnID string

+ TenantID uuid.UUID

+ type CreateTopupResult struct

+ ClientSecret string

+ GatewayTxnID string

+ TransactionID uuid.UUID

+ type DB interface

+ Begin func() (*sql.Tx, error)

+ Exec func(query string, args ...interface{}) (sql.Result, error)

+ Query func(query string, args ...interface{}) (*sql.Rows, error)

+ QueryRow func(query string, args ...interface{}) *sql.Row

+ type Gateway interface

+ CreateTopupPayment func(ctx context.Context, in TopupPaymentInput) (TopupPaymentResult, error)

+ Name func() string

+ ParseWebhook func(payload []byte, headers http.Header) (WebhookEvent, error)

+ Validate func(ctx context.Context) error

+ type GatewaySetting struct

+ Config map[string]string

+ DisplayName string

+ IsEnabled bool

+ IsTestMode bool

+ Name string

+ type PaymentMethod struct

+ CardBrand string

+ CardExpMonth int

+ CardExpYear int

+ CardLast4 string

+ Gateway string

+ GatewayCustomerID string

+ GatewayPaymentMethodID string

+ ID uuid.UUID

+ IsDefault bool

+ Nickname string

+ PaymentType string

+ type SavedChargeInput struct

+ AmountCents int64

+ Currency string

+ CustomerID string

+ Metadata map[string]string

+ PaymentMethodID string

+ type SavedMethodGateway interface

+ ChargeSavedMethod func(ctx context.Context, in SavedChargeInput) (gatewayTxnID string, succeeded bool, err error)

+ CreateCustomer func(ctx context.Context, email, name string, metadata map[string]string) (customerID string, err error)

+ DetachPaymentMethod func(ctx context.Context, paymentMethodID string) error

+ RetrieveCardDetails func(ctx context.Context, paymentMethodID string) (CardDetails, error)

+ type Service struct

+ func NewService(db DB, key []byte, namespace string) *Service

+ func (s *Service) CaptureTopup(ctx context.Context, tenantID uuid.UUID, gateway, gatewayTxnID string) (bool, error)

+ func (s *Service) ChargeSavedMethod(ctx context.Context, tenantID, methodID uuid.UUID, amountCents int64) (CreateTopupResult, error)

+ func (s *Service) CompleteTopup(transactionID uuid.UUID) (credited bool, err error)

+ func (s *Service) CreateTopup(ctx context.Context, in TopupRequest) (CreateTopupResult, error)

+ func (s *Service) CreateTopupTransaction(in CreateTopupInput) (uuid.UUID, error)

+ func (s *Service) DeletePaymentMethod(ctx context.Context, tenantID, methodID uuid.UUID) error

+ func (s *Service) Gateway(name string) (Gateway, error)

+ func (s *Service) GatewaySetting(name string) (*GatewaySetting, error)

+ func (s *Service) ListPaymentMethods(tenantID uuid.UUID) ([]PaymentMethod, error)

+ func (s *Service) MarkTopupFailed(transactionID uuid.UUID) error

+ func (s *Service) ProcessWebhook(ctx context.Context, gateway string, payload []byte, headers http.Header) error

+ func (s *Service) SetDefaultPaymentMethod(tenantID, methodID uuid.UUID) error

+ func (s *Service) TenantBalance(tenantID uuid.UUID) (string, error)

+ func (s *Service) TopupOptions(tenantID uuid.UUID) (TopupOptions, error)

+ func (s *Service) UpsertGatewaySetting(name, displayName string, isEnabled, isTestMode bool, config map[string]string) error

+ type TopupGatewayOption struct

+ Name string

+ PublicKey string

+ TestMode bool

+ type TopupOptions struct

+ Balance string

+ Gateways []TopupGatewayOption

+ type TopupPaymentInput struct

+ AmountCents int64

+ Currency string

+ CustomerID string

+ Metadata map[string]string

+ SaveCard bool

+ type TopupPaymentResult struct

+ ClientSecret string

+ GatewayTxnID string

+ type TopupRequest struct

+ AmountCents int64

+ CustomerEmail string

+ CustomerName string

+ Gateway string

+ SaveCard bool

+ TenantID uuid.UUID

+ type WebhookEvent struct

+ CustomerID string

+ EventID string

+ EventType string

+ GatewayTxnID string

+ Kind WebhookEventKind

+ PaymentMethodID string

+ SavesPaymentMethod bool

+ type WebhookEventKind int

+ const WebhookIgnored

+ const WebhookTopupFailed

+ const WebhookTopupSucceeded

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