gopay

package module

Go to main page

Versions in this module

v0

v0.8.0

Jul 6, 2026

Changes in this version

type Client

+ func (c *Client) GetInvoice(ctx context.Context, invoiceID string) (*Invoice, error)

+ type Invoice struct

+ Amount *Amount

+ AmountPaid *Amount

+ CreatedAt time.Time

+ CustomerID string

+ DueDate time.Time

+ HostedInvoiceURL string

+ ID string

+ Metadata map[string]string

+ Number string

+ PDFURL string

+ PaidAt time.Time

+ Provider string

+ Raw map[string]any

+ Status InvoiceStatus

+ SubscriptionID string

+ func (i *Invoice) IsPaid() bool

+ type InvoiceProvider interface

+ GetInvoice func(ctx context.Context, invoiceID string) (*Invoice, error)

+ type InvoiceStatus string

+ const InvoiceStatusDraft

+ const InvoiceStatusOpen

+ const InvoiceStatusPaid

+ const InvoiceStatusUncollectible

+ const InvoiceStatusVoid

+ func (s InvoiceStatus) String() string

type MockProvider

+ func (p *MockProvider) AddInvoice(inv *Invoice) *MockProvider

+ func (p *MockProvider) GetInvoice(_ context.Context, invoiceID string) (*Invoice, error)

v0.7.0

Jul 5, 2026

v0.6.1

Jun 26, 2026

v0.6.0

Jun 25, 2026

Changes in this version

type Subscription

+ AuthURL string

type SubscriptionRequest

+ TotalCount int

+ func (r *SubscriptionRequest) WithTotalCount(count int) *SubscriptionRequest

type SubscriptionStatus

+ const SubscriptionStatusCompleted

v0.5.1

Jun 16, 2026

v0.5.0

Jun 15, 2026

Changes in this version

+ var ErrSubscriptionFailed = errors.New("gopay: subscription failed")

+ type BillingInterval string

+ const BillingIntervalDay

+ const BillingIntervalMonth

+ const BillingIntervalWeek

+ const BillingIntervalYear

+ func (b BillingInterval) String() string

+ type CancelOptions struct

+ AtPeriodEnd bool

type Client

+ func (c *Client) CancelSubscription(ctx context.Context, subscriptionID string, opts *CancelOptions) (*Subscription, error)

+ func (c *Client) CreatePlan(ctx context.Context, req *PlanRequest) (*Plan, error)

+ func (c *Client) CreateSubscription(ctx context.Context, req *SubscriptionRequest) (*Subscription, error)

+ func (c *Client) GetPlan(ctx context.Context, planID string) (*Plan, error)

+ func (c *Client) GetSubscription(ctx context.Context, subscriptionID string) (*Subscription, error)

type MockProvider

+ func (p *MockProvider) CancelSubscription(_ context.Context, subscriptionID string, opts *CancelOptions) (*Subscription, error)

+ func (p *MockProvider) CreatePlan(_ context.Context, req *PlanRequest) (*Plan, error)

+ func (p *MockProvider) CreateSubscription(_ context.Context, req *SubscriptionRequest) (*Subscription, error)

+ func (p *MockProvider) GetPlan(_ context.Context, planID string) (*Plan, error)

+ func (p *MockProvider) GetSubscription(_ context.Context, subscriptionID string) (*Subscription, error)

+ func (p *MockProvider) SetPlan(plan *Plan)

+ func (p *MockProvider) SetSubscription(sub *Subscription)

+ func (p *MockProvider) WithSubscriptionError(err error) *MockProvider

+ type Plan struct

+ Amount *Amount

+ CreatedAt time.Time

+ ID string

+ Interval BillingInterval

+ IntervalCount int

+ Metadata map[string]string

+ Name string

+ Provider string

+ Raw map[string]any

+ type PlanRequest struct

+ Amount *Amount

+ IdempotencyKey string

+ Interval BillingInterval

+ IntervalCount int

+ Metadata map[string]string

+ Name string

+ func NewPlanRequest(amount *Amount, interval BillingInterval) *PlanRequest

+ func (r *PlanRequest) Validate() error

+ func (r *PlanRequest) WithIdempotencyKey(key string) *PlanRequest

+ func (r *PlanRequest) WithIntervalCount(count int) *PlanRequest

+ func (r *PlanRequest) WithMetadata(key, value string) *PlanRequest

+ func (r *PlanRequest) WithName(name string) *PlanRequest

+ type Subscription struct

+ CancelAtPeriodEnd bool

+ CanceledAt time.Time

+ CreatedAt time.Time

+ CurrentPeriodEnd time.Time

+ CurrentPeriodStart time.Time

+ CustomerID string

+ ID string

+ Metadata map[string]string

+ PaymentMethodID string

+ PlanID string

+ Provider string

+ Raw map[string]any

+ Status SubscriptionStatus

+ func (s *Subscription) IsActive() bool

+ type SubscriptionProvider interface

+ CancelSubscription func(ctx context.Context, subscriptionID string, opts *CancelOptions) (*Subscription, error)

+ CreatePlan func(ctx context.Context, req *PlanRequest) (*Plan, error)

+ CreateSubscription func(ctx context.Context, req *SubscriptionRequest) (*Subscription, error)

+ GetPlan func(ctx context.Context, planID string) (*Plan, error)

+ GetSubscription func(ctx context.Context, subscriptionID string) (*Subscription, error)

+ type SubscriptionRequest struct

+ CustomerID string

+ IdempotencyKey string

+ Metadata map[string]string

+ PaymentMethodID string

+ PlanID string

+ TrialDays int

+ func NewSubscriptionRequest(customerID, planID string) *SubscriptionRequest

+ func (r *SubscriptionRequest) Validate() error

+ func (r *SubscriptionRequest) WithIdempotencyKey(key string) *SubscriptionRequest

+ func (r *SubscriptionRequest) WithMetadata(key, value string) *SubscriptionRequest

+ func (r *SubscriptionRequest) WithPaymentMethod(paymentMethodID string) *SubscriptionRequest

+ func (r *SubscriptionRequest) WithTrialDays(days int) *SubscriptionRequest

+ type SubscriptionStatus string

+ const SubscriptionStatusActive

+ const SubscriptionStatusCanceled

+ const SubscriptionStatusIncomplete

+ const SubscriptionStatusIncompleteExpired

+ const SubscriptionStatusPastDue

+ const SubscriptionStatusTrialing

+ const SubscriptionStatusUnpaid

+ func (s SubscriptionStatus) String() string

type WebhookEvent

+ InvoiceID string

+ SubscriptionID string

type WebhookEventKind

+ const WebhookInvoicePaymentFailed

+ const WebhookInvoicePaymentSucceeded

+ const WebhookSubscriptionCanceled

+ const WebhookSubscriptionCreated

+ const WebhookSubscriptionUpdated

v0.4.0

Jun 15, 2026

Changes in this version

+ var ErrSetupFailed = errors.New("gopay: setup failed")

type Client

+ func (c *Client) CancelSetupIntent(ctx context.Context, setupIntentID string) (*SetupIntent, error)

+ func (c *Client) CreateSetupIntent(ctx context.Context, req *SetupIntentRequest) (*SetupIntent, error)

+ func (c *Client) GetSetupIntent(ctx context.Context, setupIntentID string) (*SetupIntent, error)

type MockProvider

+ func (p *MockProvider) CancelSetupIntent(_ context.Context, setupIntentID string) (*SetupIntent, error)

+ func (p *MockProvider) CreateSetupIntent(_ context.Context, req *SetupIntentRequest) (*SetupIntent, error)

+ func (p *MockProvider) GetSetupIntent(_ context.Context, setupIntentID string) (*SetupIntent, error)

+ func (p *MockProvider) SetSetupIntent(si *SetupIntent)

+ func (p *MockProvider) WithSetupError(err error) *MockProvider

+ type SetupIntent struct

+ ClientSecret string

+ CreatedAt time.Time

+ CustomerID string

+ Description string

+ FailureCode string

+ FailureMessage string

+ ID string

+ Metadata map[string]string

+ PaymentMethodID string

+ Provider string

+ Raw map[string]any

+ RedirectURL string

+ Status SetupIntentStatus

+ Usage SetupIntentUsage

+ func (s *SetupIntent) IsSucceeded() bool

+ func (s *SetupIntent) RequiresAction() bool

+ type SetupIntentProvider interface

+ CancelSetupIntent func(ctx context.Context, setupIntentID string) (*SetupIntent, error)

+ CreateSetupIntent func(ctx context.Context, req *SetupIntentRequest) (*SetupIntent, error)

+ GetSetupIntent func(ctx context.Context, setupIntentID string) (*SetupIntent, error)

+ type SetupIntentRequest struct

+ CustomerID string

+ Description string

+ IdempotencyKey string

+ Metadata map[string]string

+ PaymentMethodID string

+ ReturnURL string

+ Usage SetupIntentUsage

+ func NewSetupIntentRequest() *SetupIntentRequest

+ func (r *SetupIntentRequest) Validate() error

+ func (r *SetupIntentRequest) WithCustomer(customerID string) *SetupIntentRequest

+ func (r *SetupIntentRequest) WithDescription(desc string) *SetupIntentRequest

+ func (r *SetupIntentRequest) WithIdempotencyKey(key string) *SetupIntentRequest

+ func (r *SetupIntentRequest) WithMetadata(key, value string) *SetupIntentRequest

+ func (r *SetupIntentRequest) WithPaymentMethod(paymentMethodID string) *SetupIntentRequest

+ func (r *SetupIntentRequest) WithReturnURL(url string) *SetupIntentRequest

+ func (r *SetupIntentRequest) WithUsage(usage SetupIntentUsage) *SetupIntentRequest

+ type SetupIntentStatus string

+ const SetupIntentStatusCanceled

+ const SetupIntentStatusProcessing

+ const SetupIntentStatusRequiresAction

+ const SetupIntentStatusRequiresConfirmation

+ const SetupIntentStatusRequiresPaymentMethod

+ const SetupIntentStatusSucceeded

+ func (s SetupIntentStatus) String() string

+ type SetupIntentUsage string

+ const SetupIntentUsageOffSession

+ const SetupIntentUsageOnSession

+ func (u SetupIntentUsage) String() string

type WebhookEvent

+ SetupIntentID string

type WebhookEventKind

+ const WebhookSetupFailed

+ const WebhookSetupSucceeded

v0.3.0

Jun 14, 2026

Changes in this version

+ const DefaultListLimit

+ const MaxListLimit

type Client

+ func (c *Client) ListCustomers(ctx context.Context, params *ListParams) (*List[*Customer], error)

+ func (c *Client) ListPayments(ctx context.Context, params *ListParams) (*List[*Payment], error)

+ func (c *Client) ListRefunds(ctx context.Context, params *ListParams) (*List[*Refund], error)

+ type List struct

+ HasMore bool

+ Items []T

+ NextCursor string

+ type ListParams struct

+ Cursor string

+ Limit int

+ func NewListParams() *ListParams

+ func (p *ListParams) EffectiveLimit() int

+ func (p *ListParams) Validate() error

+ func (p *ListParams) WithCursor(cursor string) *ListParams

+ func (p *ListParams) WithLimit(limit int) *ListParams

+ type ListProvider interface

+ ListCustomers func(ctx context.Context, params *ListParams) (*List[*Customer], error)

+ ListPayments func(ctx context.Context, params *ListParams) (*List[*Payment], error)

+ ListRefunds func(ctx context.Context, params *ListParams) (*List[*Refund], error)

type MockProvider

+ func (p *MockProvider) ListCustomers(_ context.Context, params *ListParams) (*List[*Customer], error)

+ func (p *MockProvider) ListPayments(_ context.Context, params *ListParams) (*List[*Payment], error)

+ func (p *MockProvider) ListRefunds(_ context.Context, params *ListParams) (*List[*Refund], error)

v0.2.0

Jun 11, 2026

Changes in this version

type Amount

+ func ParseMajorUnitAmount(value, currency string) (*Amount, bool)

type WebhookEvent

+ Amount *Amount

+ Kind WebhookEventKind

+ OrderID string

+ PaymentID string

+ RefundID string

+ type WebhookEventKind string

+ const WebhookPaymentCanceled

+ const WebhookPaymentCreated

+ const WebhookPaymentFailed

+ const WebhookPaymentSucceeded

+ const WebhookRefundFailed

+ const WebhookRefundSucceeded

+ const WebhookUnknown

+ func (k WebhookEventKind) String() string

v0.1.1

Jun 7, 2026

v0.1.0

Mar 18, 2026

Changes in this version

+ var ErrAlreadyCaptured = errors.New("gopay: already captured")

+ var ErrAlreadyRefunded = errors.New("gopay: already refunded")

+ var ErrAuthenticationRequired = errors.New("gopay: authentication required")

+ var ErrCardDeclined = errors.New("gopay: card declined")

+ var ErrExpiredCard = errors.New("gopay: expired card")

+ var ErrInsufficientFunds = errors.New("gopay: insufficient funds")

+ var ErrInvalidAmount = errors.New("gopay: invalid amount")

+ var ErrInvalidCard = errors.New("gopay: invalid card")

+ var ErrInvalidConfig = errors.New("gopay: invalid configuration")

+ var ErrInvalidCurrency = errors.New("gopay: invalid currency")

+ var ErrNotFound = errors.New("gopay: not found")

+ var ErrPaymentFailed = errors.New("gopay: payment failed")

+ var ErrProviderError = errors.New("gopay: provider error")

+ var ErrRefundFailed = errors.New("gopay: refund failed")

+ var ErrUnsupported = errors.New("gopay: operation not supported")

+ type Address struct

+ City string

+ Country string

+ Line1 string

+ Line2 string

+ PostalCode string

+ State string

+ type Amount struct

+ Currency string

+ Value int64

+ func EUR(cents int64) *Amount

+ func GBP(pence int64) *Amount

+ func INR(paise int64) *Amount

+ func NewAmount(value int64, currency string) *Amount

+ func USD(cents int64) *Amount

+ func (a *Amount) Validate() error

+ type BillingDetails struct

+ Address *Address

+ Email string

+ Name string

+ Phone string

+ type CaptureMethod string

+ const CaptureAutomatic

+ const CaptureManual

+ func (c CaptureMethod) String() string

+ type CardDetails struct

+ Brand string

+ Country string

+ ExpMonth int

+ ExpYear int

+ Funding string

+ Last4 string

+ type Client struct

+ func NewClient(provider Provider) (*Client, error)

+ func (c *Client) AttachPaymentMethod(ctx context.Context, customerID, paymentMethodID string) error

+ func (c *Client) CancelPayment(ctx context.Context, paymentID string) (*Payment, error)

+ func (c *Client) CapturePayment(ctx context.Context, paymentID string, amount *Amount) (*Payment, error)

+ func (c *Client) CreateCustomer(ctx context.Context, req *CustomerRequest) (*Customer, error)

+ func (c *Client) CreatePayment(ctx context.Context, req *PaymentRequest) (*Payment, error)

+ func (c *Client) DeleteCustomer(ctx context.Context, customerID string) error

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

+ func (c *Client) FullRefund(ctx context.Context, paymentID string) (*Refund, error)

+ func (c *Client) GetCustomer(ctx context.Context, customerID string) (*Customer, error)

+ func (c *Client) GetPayment(ctx context.Context, paymentID string) (*Payment, error)

+ func (c *Client) GetRefund(ctx context.Context, refundID string) (*Refund, error)

+ func (c *Client) ListPaymentMethods(ctx context.Context, customerID string) ([]*PaymentMethod, error)

+ func (c *Client) Provider() Provider

+ func (c *Client) ProviderName() string

+ func (c *Client) Refund(ctx context.Context, req *RefundRequest) (*Refund, error)

+ func (c *Client) UpdateCustomer(ctx context.Context, customerID string, req *CustomerRequest) (*Customer, error)

+ func (c *Client) VerifyWebhook(ctx context.Context, payload []byte, headers map[string]string) (*WebhookEvent, error)

+ type Customer struct

+ CreatedAt time.Time

+ DefaultPaymentMethodID string

+ Description string

+ Email string

+ ID string

+ Metadata map[string]string

+ Name string

+ Phone string

+ Provider string

+ Raw map[string]any

+ type CustomerProvider interface

+ CreateCustomer func(ctx context.Context, req *CustomerRequest) (*Customer, error)

+ DeleteCustomer func(ctx context.Context, customerID string) error

+ GetCustomer func(ctx context.Context, customerID string) (*Customer, error)

+ UpdateCustomer func(ctx context.Context, customerID string, req *CustomerRequest) (*Customer, error)

+ type CustomerRequest struct

+ Description string

+ Email string

+ Metadata map[string]string

+ Name string

+ Phone string

+ func NewCustomerRequest(email string) *CustomerRequest

+ func (r *CustomerRequest) Validate() error

+ func (r *CustomerRequest) WithDescription(desc string) *CustomerRequest

+ func (r *CustomerRequest) WithMetadata(key, value string) *CustomerRequest

+ func (r *CustomerRequest) WithName(name string) *CustomerRequest

+ func (r *CustomerRequest) WithPhone(phone string) *CustomerRequest

+ type MockProvider struct

+ func NewMockProvider() *MockProvider

+ func (p *MockProvider) AttachPaymentMethod(ctx context.Context, customerID, paymentMethodID string) error

+ func (p *MockProvider) CancelPayment(ctx context.Context, paymentID string) (*Payment, error)

+ func (p *MockProvider) CapturePayment(ctx context.Context, paymentID string, amount *Amount) (*Payment, error)

+ func (p *MockProvider) CreateCustomer(ctx context.Context, req *CustomerRequest) (*Customer, error)

+ func (p *MockProvider) CreatePayment(ctx context.Context, req *PaymentRequest) (*Payment, error)

+ func (p *MockProvider) Customers() map[string]*Customer

+ func (p *MockProvider) DeleteCustomer(ctx context.Context, customerID string) error

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

+ func (p *MockProvider) GetCustomer(ctx context.Context, customerID string) (*Customer, error)

+ func (p *MockProvider) GetPayment(ctx context.Context, paymentID string) (*Payment, error)

+ func (p *MockProvider) GetRefund(ctx context.Context, refundID string) (*Refund, error)

+ func (p *MockProvider) ListPaymentMethods(ctx context.Context, customerID string) ([]*PaymentMethod, error)

+ func (p *MockProvider) Name() string

+ func (p *MockProvider) Payments() map[string]*Payment

+ func (p *MockProvider) Refund(ctx context.Context, req *RefundRequest) (*Refund, error)

+ func (p *MockProvider) Refunds() map[string]*Refund

+ func (p *MockProvider) Reset()

+ func (p *MockProvider) SetCustomer(customer *Customer)

+ func (p *MockProvider) SetPayment(payment *Payment)

+ func (p *MockProvider) SetRefund(refund *Refund)

+ func (p *MockProvider) UpdateCustomer(ctx context.Context, customerID string, req *CustomerRequest) (*Customer, error)

+ func (p *MockProvider) VerifyWebhook(_ context.Context, payload []byte, _ map[string]string) (*WebhookEvent, error)

+ func (p *MockProvider) WithAutoCapture(auto bool) *MockProvider

+ func (p *MockProvider) WithAutoSucceed(auto bool) *MockProvider

+ func (p *MockProvider) WithCaptureError(err error) *MockProvider

+ func (p *MockProvider) WithCreateError(err error) *MockProvider

+ func (p *MockProvider) WithRefundError(err error) *MockProvider

+ func (p *MockProvider) WithWebhookError(err error) *MockProvider

+ type Payment struct

+ Amount *Amount

+ AmountCaptured int64

+ AmountRefunded int64

+ CaptureMethod CaptureMethod

+ ClientSecret string

+ CreatedAt time.Time

+ CustomerID string

+ Description string

+ FailureCode string

+ FailureMessage string

+ ID string

+ Metadata map[string]string

+ PaymentMethodID string

+ Provider string

+ Raw map[string]any

+ RedirectURL string

+ Status PaymentStatus

+ func (p *Payment) IsCaptured() bool

+ func (p *Payment) IsSuccessful() bool

+ func (p *Payment) RequiresAction() bool

+ type PaymentMethod struct

+ BillingDetails *BillingDetails

+ Card *CardDetails

+ CreatedAt time.Time

+ CustomerID string

+ ID string

+ Provider string

+ Raw map[string]any

+ Type PaymentMethodType

+ type PaymentMethodProvider interface

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

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

+ ListPaymentMethods func(ctx context.Context, customerID string) ([]*PaymentMethod, error)

+ type PaymentMethodType string

+ const PaymentMethodBankAccount

+ const PaymentMethodCard

+ const PaymentMethodNetBanking

+ const PaymentMethodUPI

+ const PaymentMethodWallet

+ func (t PaymentMethodType) String() string

+ type PaymentRequest struct

+ Amount *Amount

+ CaptureMethod CaptureMethod

+ CustomerID string

+ Description string

+ IdempotencyKey string

+ Metadata map[string]string

+ PaymentMethodID string

+ ReturnURL string

+ func NewPaymentRequest(amount *Amount) *PaymentRequest

+ func (r *PaymentRequest) Validate() error

+ func (r *PaymentRequest) WithCaptureMethod(method CaptureMethod) *PaymentRequest

+ func (r *PaymentRequest) WithCustomer(customerID string) *PaymentRequest

+ func (r *PaymentRequest) WithDescription(desc string) *PaymentRequest

+ func (r *PaymentRequest) WithIdempotencyKey(key string) *PaymentRequest

+ func (r *PaymentRequest) WithMetadata(key, value string) *PaymentRequest

+ func (r *PaymentRequest) WithPaymentMethod(paymentMethodID string) *PaymentRequest

+ func (r *PaymentRequest) WithReturnURL(url string) *PaymentRequest

+ type PaymentStatus string

+ const PaymentStatusCanceled

+ const PaymentStatusFailed

+ const PaymentStatusPending

+ const PaymentStatusProcessing

+ const PaymentStatusRequiresAction

+ const PaymentStatusRequiresCapture

+ const PaymentStatusSucceeded

+ func (s PaymentStatus) String() string

+ type Provider interface

+ CancelPayment func(ctx context.Context, paymentID string) (*Payment, error)

+ CapturePayment func(ctx context.Context, paymentID string, amount *Amount) (*Payment, error)

+ CreatePayment func(ctx context.Context, req *PaymentRequest) (*Payment, error)

+ GetPayment func(ctx context.Context, paymentID string) (*Payment, error)

+ GetRefund func(ctx context.Context, refundID string) (*Refund, error)

+ Name func() string

+ Refund func(ctx context.Context, req *RefundRequest) (*Refund, error)

+ type Refund struct

+ Amount *Amount

+ CreatedAt time.Time

+ FailureReason string

+ ID string

+ Metadata map[string]string

+ PaymentID string

+ Provider string

+ Raw map[string]any

+ Reason RefundReason

+ Status RefundStatus

+ func (r *Refund) IsSuccessful() bool

+ type RefundReason string

+ const RefundReasonDuplicate

+ const RefundReasonFraudulent

+ const RefundReasonOther

+ const RefundReasonRequestedByCustomer

+ func (r RefundReason) String() string

+ type RefundRequest struct

+ Amount *Amount

+ IdempotencyKey string

+ Metadata map[string]string

+ PaymentID string

+ Reason RefundReason

+ func NewRefundRequest(paymentID string) *RefundRequest

+ func (r *RefundRequest) Validate() error

+ func (r *RefundRequest) WithAmount(amount *Amount) *RefundRequest

+ func (r *RefundRequest) WithIdempotencyKey(key string) *RefundRequest

+ func (r *RefundRequest) WithMetadata(key, value string) *RefundRequest

+ func (r *RefundRequest) WithReason(reason RefundReason) *RefundRequest

+ type RefundStatus string

+ const RefundStatusCanceled

+ const RefundStatusFailed

+ const RefundStatusPending

+ const RefundStatusSucceeded

+ func (s RefundStatus) String() string

+ type WebhookEvent struct

+ ID string

+ Provider string

+ Raw []byte

+ Type string

+ type WebhookProvider interface

+ VerifyWebhook func(ctx context.Context, payload []byte, headers map[string]string) (*WebhookEvent, error)

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