btcpay

package module
v0.0.0-...-114f83f Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 23, 2021 License: MIT Imports: 6 Imported by: 0

README

Go-BTCPay

testing

-- Work in progress --

A Golang SDK for the BTCPay Server Greenfield API v1.

💡 About

This package provies full access to the Greenfield API v1 from a BTCPayServer. Every API call returns, if available, a corresponding go struct, a HTTP status code and an error.

It's possible to control the individual calls by passing a context for each function and method.

🚀 Getting started

🧑‍💻 Create a client

You can create a client either by using basic authentication or by using an API Key.

package main

import (
    "context"
    "fmt"
    "github.com/jon4hz/go-btcpay"
)

func main() {
    // create empty context interface
    ctx := context.Background()

    // Create a basicAuth client
    client := btcpay.NewBasicClient("https://mybtcpayserver.com", "myUsername", "myPassword")

    // Print informations about the server, etc
    fmt.Println(client.GetServerInfo(ctx))

    // Does the same but with an APIKey instead of basicAuth
    // Create a client with an APIKey
    client2 := btcpay.NewClient("https://mybtcpayserver.com", btcpay.APIKey("myAPIKey")

    // Print informations about the server, etc again but use the APIKey based client
    fmt.Println(client2.GetServerInfo(ctx))
}
📝 Create an invoice

You can create an invoice by using the previously created client.

// assign a store to the client
client.Store.ID = btcpay.StoreID("YourStoreID")

// create the invoice
invoice, _, err := client.CreateInvoice(context.TODO(), &client.Store.ID, &btcpay.InvoiceRequest{
    Amount:   "10",
    Currency: "USD",
})
if err != nil {
   fmt.Println(err)
} else {
    fmt.Println(invoice) // invoice has type *btcpay.InvoiceResponse
}

Calling the method CreateInvoice() works for variable of type *btcpay.Store, too.

// by passing the store from the previously created client, the new store (*btcpay.Store) contains 
// a pointer  back to the initial client 
store = client.Store
// assign a storeID to the store
store.ID = btcpay.StoreID("YourStoreID")

// create the invoice
invoice, _, err := store.CreateInvoice(context.TODO(), &btcpay.InvoiceRequest{
    Amount:   "10",
    Currency: "USD",
})
if err != nil {
   fmt.Println(err)
} else {
    fmt.Println(invoice) // invoice has type *btcpay.InvoiceResponse
}

[more examples will follow soon]

initialented endpoints.

Endpoint Status
/api/v1/api-keys ✅ Fully implemented
/api-keys/authorize ⚡️ Testing required
/api/v1/health ✅ Fully implemented
/api/v1/server/info ✅ Fully implemented
/api/v1/users ✅ Fully implemented
/api/v1/users/me/notifications ✅ Fully implemented
/api/v1/stores ⚠️ Partially implemented
/api/v1/stores/{storeId}/invoices ✅ Fully implemented
/api/v1/stores/{storeId}/payment-requests ✅ Fully implemented
/api/v1/stores/{storeId}/pull-payments ✅ Fully implemented
/api/v1/stores/{storeId}/payment-methods/OnChain/{cryptoCode}/wallet ⏳ Work in progress
/misc/lang ✅ Fully implemented
/i ✅ Fully implemented
/api/v1/pull-payments ✅ Fully implemented

📜 Licensing

This SDK is released under the MIT-License found in the LICENSE file.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIKey 

type APIKey string

type APIKeyRequest 

type APIKeyRequest struct {
	Label       string             `json:"label,omitempty"`
	Permissions []BTCPayPermission `json:"permissions,omitempty"`
}

type APIKeyResponse 

type APIKeyResponse struct {
	APIKey      APIKey             `json:"apiKey"`
	Label       string             `json:"label"`
	Permissions []BTCPayPermission `json:"permissions"`
}

type AuthorizationRequest 

type AuthorizationRequest struct {
	Permissions           []BTCPayPermission `json:"permissions,omitempty"`
	ApplicationName       string             `json:"applicationName,omitempty"`
	Strict                bool               `json:"strict,omitempty"`
	SelectiveStores       bool               `json:"selectiveStores,omitempty"`
	Redirect              string             `json:"redirect,omitempty"`
	ApplicationIdentifier string             `json:"applicationIdentifier,omitempty"`
}

type BTCPayInvoiceAdditionalStatus 

type BTCPayInvoiceAdditionalStatus string

Enums InvoiceAdditionalStatus

type BTCPayInvoiceStatus 

type BTCPayInvoiceStatus string

Enums InvoiceStatus

type BTCPayInvoiceStatusMark 

type BTCPayInvoiceStatusMark string

Enums InvoiceStatusMark

type BTCPayNetworkFeeMode 

type BTCPayNetworkFeeMode string

Enums NetworkFeeMode

type BTCPayPaymentRequestStatus 

type BTCPayPaymentRequestStatus string

Enums PaymentRequestStatus

type BTCPayPaymentStatus 

type BTCPayPaymentStatus string

Enums PaymentStatus

type BTCPayPayoutStatus 

type BTCPayPayoutStatus string

Enums NetworkFeeMode

type BTCPayPermission 

type BTCPayPermission string

Enums BTCPayPermission

func CreateCustomPermission 

func CreateCustomPermission(permission BTCPayPermission, storeID StoreID) BTCPayPermission

type BTCPaySpeedPolicy 

type BTCPaySpeedPolicy string

Enums SpeedPolicy

type Client 

type Client struct {
	URL            string
	APIKey         APIKey
	Username       string
	Password       string
	Http           *http.Client
	Store          *Store
	Invoice        *Invoice
	PaymentRequest *PaymentRequest
	Notification   *Notification
	PullPayment    *PullPayment
	Payout         *Payout
}

func NewBasicClient 

func NewBasicClient(url, username, password string) *Client

func NewClient 

func NewClient(url string, apiKey APIKey) *Client

func (*Client) ApprovePayout 

func (c *Client) ApprovePayout(ctx context.Context, storeID *StoreID, payoutID *PayoutID, payoutApproveRequest *PayoutApproveRequest) (*PayoutResponse, int, error)

Approve a payout

func (*Client) ArchiveInvoice 

func (c *Client) ArchiveInvoice(ctx context.Context, storeID *StoreID, invoiceID *InvoiceID) (int, error)

Archive a single invoice of a store

func (*Client) ArchivePaymentRequest 

func (c *Client) ArchivePaymentRequest(ctx context.Context, storeID *StoreID, paymentRequestID *PaymentRequestID) (int, error)

Archives the specified payment request.

func (*Client) ArchivePullPayment 

func (c *Client) ArchivePullPayment(ctx context.Context, storeID *StoreID, pullPaymentID *PullPaymentID) (int, error)

func (*Client) Authorize 

func (c *Client) Authorize(ctx context.Context, authRequest *AuthorizationRequest) (int, error)

func (*Client) CancelPayout 

func (c *Client) CancelPayout(ctx context.Context, storeID *StoreID, payoutID *PayoutID) (int, error)

Cancel the payout

func (*Client) CreateAPIKey 

func (c *Client) CreateAPIKey(ctx context.Context, apiKeyRequest *APIKeyRequest) (*APIKeyResponse, int, error)

func (*Client) CreateInvoice 

func (c *Client) CreateInvoice(ctx context.Context, storeID *StoreID, invoiceRequest *InvoiceRequest) (*InvoiceResponse, int, error)

Create an invoice for a certain store

func (*Client) CreatePaymentRequest 

func (c *Client) CreatePaymentRequest(ctx context.Context, storeID *StoreID, paymentRequestRequest *PaymentRequestRequest) (*PaymentRequestResponse, int, error)

Create a new payment request

func (*Client) CreatePayout 

func (c *Client) CreatePayout(ctx context.Context, pullPaymentID *PullPaymentID, payoutRequest *PayoutRequest) (*PayoutResponse, int, error)

create a new payout

func (*Client) CreatePullPayment 

func (c *Client) CreatePullPayment(ctx context.Context, storeID *StoreID, pullPaymentRequest *PullPaymentRequest) (*PullPaymentResponse, int, error)

func (*Client) CreateStore 

func (c *Client) CreateStore(ctx context.Context, storeRequest *StoreRequest) (*StoreResponse, int, error)

create a new store

func (*Client) CreateUser 

func (c *Client) CreateUser(ctx context.Context, userRequest *UserRequest) (*UserResponse, int, error)

func (*Client) GetCurrentAPIKey 

func (c *Client) GetCurrentAPIKey(ctx context.Context) (*APIKeyResponse, int, error)

func (*Client) GetHealth 

func (c *Client) GetHealth(ctx context.Context) (*HealthResponse, int, error)

func (*Client) GetInvoice 

func (c *Client) GetInvoice(ctx context.Context, storeID *StoreID, invoiceID *InvoiceID) (*InvoiceResponse, int, error)

Get a signle invoice from a single store.

func (*Client) GetInvoiceCheckoutPage 

func (c *Client) GetInvoiceCheckoutPage(ctx context.Context, invoiceID *InvoiceID, lang ...string) (*InvoiceCheckoutPage, int, error)

View the checkout page of an invoice

func (*Client) GetInvoicePaymentMethod 

func (c *Client) GetInvoicePaymentMethod(ctx context.Context, storeID *StoreID, invoiceID *InvoiceID) ([]*InvoicePaymentMethodResponse, int, error)

View information about the specified invoice's payment methods

func (*Client) GetInvoices 

func (c *Client) GetInvoices(ctx context.Context, storeID *StoreID) ([]*InvoiceResponse, int, error)

Get an array of all Invoices from a single store.

func (*Client) GetLanguageCodes 

func (c *Client) GetLanguageCodes(ctx context.Context) ([]*LanguageCodesRespose, int, error)

func (*Client) GetNotification 

func (c *Client) GetNotification(ctx context.Context, notificationID *NotificationID) (*NotificationResponse, int, error)

View information about the specified notification

func (*Client) GetNotifications 

func (c *Client) GetNotifications(ctx context.Context, seen ...bool) ([]*NotificationResponse, int, error)

func (*Client) GetPaymentRequest 

func (c *Client) GetPaymentRequest(ctx context.Context, storeID *StoreID, paymentRequestID *PaymentRequestID) (*PaymentRequestResponse, int, error)

View information about the specified payment request

func (*Client) GetPaymentRequests 

func (c *Client) GetPaymentRequests(ctx context.Context, storeID *StoreID) ([]*PaymentRequestResponse, int, error)

View information about the existing payment requests

func (*Client) GetPayouts 

func (c *Client) GetPayouts(ctx context.Context, pullPaymentID *PullPaymentID, includeCancelled ...bool) ([]*PayoutResponse, int, error)

Get payouts

func (*Client) GetPullPayment 

func (c *Client) GetPullPayment(ctx context.Context, pullPaymentID *PullPaymentID) (*PullPaymentResponse, int, error)

Get a pull payment

func (*Client) GetPullPayments 

func (c *Client) GetPullPayments(ctx context.Context, storeID *StoreID, includeArchived ...bool) ([]*PullPaymentResponse, int, error)

Get the pull payments of a store

func (*Client) GetServerInfo 

func (c *Client) GetServerInfo(ctx context.Context) (*ServerInfoResponse, int, error)

func (*Client) GetStore 

func (c *Client) GetStore(ctx context.Context, storeID *StoreID) (*StoreResponse, int, error)

View information about the specified store

func (*Client) GetStores 

func (c *Client) GetStores(ctx context.Context) ([]*StoreResponse, int, error)

View information about the available stores

func (*Client) GetUser 

func (c *Client) GetUser(ctx context.Context) (*UserResponse, int, error)

View information about the current user

func (*Client) MarkInvoiceStatus 

func (c *Client) MarkInvoiceStatus(ctx context.Context, storeID *StoreID, invoiceID *InvoiceID, markInvoiceStatusRequest *MarkInvoiceStatusRequest) (*InvoiceResponse, int, error)

Mark an invoice as invalid or settled.

func (*Client) RemoveNotification 

func (c *Client) RemoveNotification(ctx context.Context, notificationID *NotificationID) (int, error)

Removes the specified notification.

func (*Client) RemoveStore 

func (c *Client) RemoveStore(ctx context.Context, storeID *StoreID) (int, error)

Removes the specified store. If there is another user with access, only your access will be removed.

func (*Client) RevokeAPIKey 

func (c *Client) RevokeAPIKey(ctx context.Context, apiKey *APIKey) (int, error)

func (*Client) RevokeCurrentAPIKey 

func (c *Client) RevokeCurrentAPIKey(ctx context.Context) (*APIKeyResponse, int, error)

func (*Client) UnarchiveInvoice 

func (c *Client) UnarchiveInvoice(ctx context.Context, storeID *StoreID, invoiceID *InvoiceID) (*InvoiceResponse, int, error)

unarchive an invoice

func (*Client) UpdateInvoice 

func (c *Client) UpdateInvoice(ctx context.Context, storeID *StoreID, invoiceID *InvoiceID, invoiceUpdate *InvoiceUpdate) (*InvoiceResponse, int, error)

Update the metadata from an existing invoice

func (*Client) UpdateNotification 

func (c *Client) UpdateNotification(ctx context.Context, notificationID *NotificationID, updateNotification ...*UpdateNotification) (*NotificationResponse, int, error)

Updates the notification

func (*Client) UpdatePaymentRequest 

func (c *Client) UpdatePaymentRequest(ctx context.Context, storeID *StoreID, paymentRequestID *PaymentRequestID, paymentRequestUpdate *PaymentRequestRequest) (*PaymentRequestResponse, int, error)

Update a payment request

func (*Client) UpdateStore 

func (c *Client) UpdateStore(ctx context.Context, storeID *StoreID, storeUpdate *StoreUpdate) (*StoreResponse, int, error)

type HealthResponse 

type HealthResponse struct {
	Synchronized bool `json:"synchronized"`
}

type Invoice 

type Invoice struct {
	Store  *Store
	Client *Client
	ID     InvoiceID
}

func (*Invoice) ArchiveInvoice 

func (i *Invoice) ArchiveInvoice(ctx context.Context) (int, error)

func (*Invoice) GetInvoice 

func (i *Invoice) GetInvoice(ctx context.Context) (*InvoiceResponse, int, error)

func (*Invoice) GetInvoiceCheckoutPage 

func (i *Invoice) GetInvoiceCheckoutPage(ctx context.Context) (*InvoiceCheckoutPage, int, error)

func (*Invoice) GetInvoicePaymentMethod 

func (i *Invoice) GetInvoicePaymentMethod(ctx context.Context) ([]*InvoicePaymentMethodResponse, int, error)

func (*Invoice) MarkInvoiceStatus 

func (i *Invoice) MarkInvoiceStatus(ctx context.Context, markInvoiceStatusRequest *MarkInvoiceStatusRequest) (*InvoiceResponse, int, error)

func (*Invoice) UnarchiveInvoice 

func (i *Invoice) UnarchiveInvoice(ctx context.Context) (*InvoiceResponse, int, error)

func (*Invoice) UpdateInvoice 

func (i *Invoice) UpdateInvoice(ctx context.Context, invoiceUpdate *InvoiceUpdate) (*InvoiceResponse, int, error)

type InvoiceAdditionalStatus 

type InvoiceAdditionalStatus struct {
	None        BTCPayInvoiceAdditionalStatus
	PaidLate    BTCPayInvoiceAdditionalStatus
	PaidPartial BTCPayInvoiceAdditionalStatus
	Marked      BTCPayInvoiceAdditionalStatus
	AddInvalid  BTCPayInvoiceAdditionalStatus
	PaidOver    BTCPayInvoiceAdditionalStatus
}

func GetInvoiceAdditionalStatus 

func GetInvoiceAdditionalStatus() *InvoiceAdditionalStatus

type InvoiceCheckout 

type InvoiceCheckout struct {
	SpeedPolicy       BTCPaySpeedPolicy `json:"speedPolicy,omitempty"`
	PaymentMethods    []string          `json:"paymentMethods,omitempty"`
	ExpirationMinutes int               `json:"expirationMinutes,omitempty"`
	MonitoringMinutes int               `json:"monitoringMinutes,omitempty"`
	PaymentTolerance  float64           `json:"paymentTolerance,omitempty"`
	RedirectURL       string            `json:"redirectURL,omitempty"`
	DefaultLanguage   string            `json:"defaultLanguage,omitempty"`
}

type InvoiceCheckoutPage 

type InvoiceCheckoutPage struct {
	Page []byte
}

type InvoiceID 

type InvoiceID string

type InvoiceMetadata 

type InvoiceMetadata map[string]interface{}

type InvoicePaymentMethodResponse 

type InvoicePaymentMethodResponse struct {
	PaymentMethod     string    `json:"paymentMethod"`
	Destination       string    `json:"destination"`
	PaymentLink       string    `json:"paymentLink,omitempty"`
	Rate              string    `json:"rate"`
	PaymentMethodPaid string    `json:"paymentMethodPaid"`
	TotalPaid         string    `json:"totalPaid"`
	Due               string    `json:"due"`
	Amount            string    `json:"amount"`
	NetworkFee        string    `json:"networkFee"`
	Payments          []Payment `json:"payments"`
}

type InvoiceRequest 

type InvoiceRequest struct {
	Amount          string          `json:"amount"`
	Currency        string          `json:"currency,omitempty"`
	Metadata        InvoiceMetadata `json:"metadata,omitempty"`
	InvoiceCheckout InvoiceCheckout `json:"checkout,omitempty"`
}

type InvoiceResponse 

type InvoiceResponse struct {
	Amount           string                        `json:"amount,omitempty"`
	Currency         string                        `json:"currency,omitempty"`
	Metadata         InvoiceMetadata               `json:"metadata,omitempty"`
	Checkout         InvoiceCheckout               `json:"checkout,omitempty"`
	ID               InvoiceID                     `json:"id"`
	CheckoutLink     string                        `json:"checkoutLink"`
	CreatedTime      int64                         `json:"createdTime"`
	ExpirationTime   int64                         `json:"expirationTime"`
	MonitoringTime   int64                         `json:"monitoringTime"`
	Status           BTCPayInvoiceStatus           `json:"status"`
	AdditionalStatus BTCPayInvoiceAdditionalStatus `json:"additionalStatus"`
}

type InvoiceStatus 

type InvoiceStatus struct {
	New        BTCPayInvoiceStatus
	Processing BTCPayInvoiceStatus
	Expired    BTCPayInvoiceStatus
	Invalid    BTCPayInvoiceStatus
	Settled    BTCPayInvoiceStatus
}

func GetInvoiceStatus 

func GetInvoiceStatus() *InvoiceStatus

type InvoiceStatusMark 

type InvoiceStatusMark struct {
	MarkInvalid  BTCPayInvoiceStatusMark
	MarkComplete BTCPayInvoiceStatusMark
}

func GetInvoiceStatusMark 

func GetInvoiceStatusMark() *InvoiceStatusMark

type InvoiceUpdate 

type InvoiceUpdate struct {
	Metadata InvoiceMetadata `json:"metadata,omitempty"`
}

type LanguageCodesRespose 

type LanguageCodesRespose struct {
	Code            string `json:"code"`
	CurrentLanguage string `json:"currentLanguage"`
}

type MarkInvoiceStatusRequest 

type MarkInvoiceStatusRequest struct {
	Status BTCPayInvoiceStatusMark `json:"status"`
}

type NetworkFeeMode 

type NetworkFeeMode struct {
	MultiplePaymentsOnly BTCPayNetworkFeeMode
	Always               BTCPayNetworkFeeMode
	Never                BTCPayNetworkFeeMode
}

func GetNetworkFeeMode 

func GetNetworkFeeMode() *NetworkFeeMode

type Notification 

type Notification struct {
	ID     NotificationID
	Client *Client
}

func (*Notification) GetNotification 

func (n *Notification) GetNotification(ctx context.Context) (*NotificationResponse, int, error)

func (*Notification) RemoveNotification 

func (n *Notification) RemoveNotification(ctx context.Context) (int, error)

func (*Notification) UpdateNotification 

func (n *Notification) UpdateNotification(ctx context.Context, updateNotification ...*UpdateNotification) (*NotificationResponse, int, error)

type NotificationID 

type NotificationID string

type NotificationResponse 

type NotificationResponse struct {
	ID          NotificationID `json:"id"`
	Body        string         `json:"body"`
	Link        string         `json:"link"`
	CreatedTime int64          `json:"createdTime"`
	Seen        bool           `json:"seen"`
}

type Payment 

type Payment struct {
	ID           PaymentID           `json:"id"`
	ReceivedDate int64               `json:"receivedDate"`
	Value        string              `json:"value"`
	Fee          string              `json:"fee"`
	Status       BTCPayPaymentStatus `json:"status"`
	Destination  string              `json:"destination"`
}

type PaymentID 

type PaymentID string

type PaymentRequest 

type PaymentRequest struct {
	Store  *Store
	Client *Client
	ID     PaymentRequestID
}

func (*PaymentRequest) ArchivePaymentRequest 

func (p *PaymentRequest) ArchivePaymentRequest(ctx context.Context) (int, error)

func (*PaymentRequest) GetPaymentRequest 

func (p *PaymentRequest) GetPaymentRequest(ctx context.Context) (*PaymentRequestResponse, int, error)

func (*PaymentRequest) UpdatePaymentRequest 

func (p *PaymentRequest) UpdatePaymentRequest(ctx context.Context, paymentRequestUpdate *PaymentRequestRequest) (*PaymentRequestResponse, int, error)

type PaymentRequestID 

type PaymentRequestID string

type PaymentRequestRequest 

type PaymentRequestRequest struct {
	Amount                    float64 `json:"amount"`
	Title                     string  `json:"title"`
	Currency                  string  `json:"currency"`
	Email                     string  `json:"email,omitempty"`
	Description               string  `json:"description,omitempty"`
	ExpiryDate                int64   `json:"expiryDate,omitempty"`
	EmbeddedCSS               string  `json:"embeddedCSS,omitempty"`
	CustomCSSLink             string  `json:"customCSSLink,omitempty"`
	AllowCustomPaymentAmounts bool    `json:"allowCustomPaymentAmounts,omitempty"`
}

type PaymentRequestResponse 

type PaymentRequestResponse struct {
	ID       PaymentRequestID           `json:"id"`
	Status   BTCPayPaymentRequestStatus `json:"status"`
	Created  string                     `json:"created"`
	Archived bool                       `json:"archived"`
	PaymentRequestRequest
}

type PaymentRequestStatus 

type PaymentRequestStatus struct {
	Pending   BTCPayInvoiceStatus
	Completed BTCPayInvoiceStatus
	Expired   BTCPayInvoiceStatus
}

func GetPaymentRequestStatus 

func GetPaymentRequestStatus() *PaymentRequestStatus

type PaymentStatus 

type PaymentStatus struct {
	New        BTCPayPaymentStatus
	Processing BTCPayPaymentStatus
	Expired    BTCPayPaymentStatus
	Invalid    BTCPayPaymentStatus
	Settled    BTCPayPaymentStatus
}

func GetPaymentStatus 

func GetPaymentStatus() *PaymentStatus

type Payout 

type Payout struct {
	Store  *Store
	Client *Client
	ID     PayoutID
}

func (*Payout) ApprovePayout 

func (p *Payout) ApprovePayout(ctx context.Context, payoutApproveRequest *PayoutApproveRequest) (*PayoutResponse, int, error)

func (*Payout) CancelPayout 

func (p *Payout) CancelPayout(ctx context.Context) (int, error)

type PayoutApproveRequest 

type PayoutApproveRequest struct {
	Revision int64  `json:"revision"`
	RateRule string `json:"rateRule,omitempty"`
}

type PayoutID 

type PayoutID string

type PayoutRequest 

type PayoutRequest struct {
	Destination   string `json:"destination"`
	Amount        string `json:"amount"`
	PaymentMethod string `json:"paymentMethod"`
}

type PayoutResponse 

type PayoutResponse struct {
	ID                  PayoutID           `json:"id"`
	Revision            int64              `json:"revision"`
	PullPaymentID       PullPaymentID      `json:"pullPaymentId"`
	Date                string             `json:"date"`
	Destination         string             `json:"destination"`
	Amount              string             `json:"amount"`
	PaymentMethod       string             `json:"paymentMethod"`
	PaymentMethodAmount string             `json:"paymentMethodAmount"`
	State               BTCPayPayoutStatus `json:"state"`
}

type PayoutStatus 

type PayoutStatus struct {
	AwaitingApproval BTCPayPayoutStatus
	AwaitingPayment  BTCPayPayoutStatus
	InProgress       BTCPayPayoutStatus
	Completed        BTCPayPayoutStatus
	Cancelled        BTCPayPayoutStatus
}

func GetPayoutStatus 

func GetPayoutStatus() *PayoutStatus

type Permission 

type Permission struct {
	Unrestricted                      BTCPayPermission
	UserCanviewprofile                BTCPayPermission
	UserCanmodifyprofile              BTCPayPermission
	UserCanmanagenotificationsforuser BTCPayPermission
	UserCanviewnotificationsforuser   BTCPayPermission

	ServerCancreateuser                         BTCPayPermission
	ServerCanmodifyserversettings               BTCPayPermission
	ServerCanuseinternallightningnode           BTCPayPermission
	ServerCancreatelightninginvoiceinternalnode BTCPayPermission

	StoreCanmodifystoresettings    BTCPayPermission
	StoreWebhooksCanmodifywebhooks BTCPayPermission
	StoreCanviewstoresettings      BTCPayPermission
	StoreCancreateinvoice          BTCPayPermission
	StoreCanviewinvoices           BTCPayPermission
	StoreCanmodifypaymentrequests  BTCPayPermission
	StoreCanviewpaymentrequests    BTCPayPermission
	StoreCanuselightningnode       BTCPayPermission
	StoreCancreatelightninginvoice BTCPayPermission
	CustomPermission               BTCPayPermission
}

func GetPermission 

func GetPermission() *Permission

type PullPayment 

type PullPayment struct {
	Store  *Store
	Client *Client
	ID     PullPaymentID
}

func (*PullPayment) ArchivePullPayment 

func (p *PullPayment) ArchivePullPayment(ctx context.Context) (int, error)

func (*PullPayment) CreatePayout 

func (p *PullPayment) CreatePayout(ctx context.Context, payoutRequest *PayoutRequest) (*PayoutResponse, int, error)

func (*PullPayment) GetPayouts 

func (p *PullPayment) GetPayouts(ctx context.Context, includeCancelled ...bool) ([]*PayoutResponse, int, error)

func (*PullPayment) GetPullPayment 

func (p *PullPayment) GetPullPayment(ctx context.Context) (*PullPaymentResponse, int, error)

type PullPaymentID 

type PullPaymentID string

type PullPaymentRequest 

type PullPaymentRequest struct {
	Name           string   `json:"name,omitempty"`
	Amount         string   `json:"amount"`
	Currency       string   `json:"currency"`
	Period         int64    `json:"period,omitempty"`
	StartsAt       int64    `json:"startsAt,omitempty"`
	ExpiresAt      int64    `json:"expiresAt,omitempty"`
	PaymentMethods []string `json:"paymentMethods"`
}

type PullPaymentResponse 

type PullPaymentResponse struct {
	ID       PullPaymentID `json:"id"`
	Name     string        `json:"name"`
	Currency string        `json:"currency"`
	Amount   string        `json:"amount"`
	Period   int64         `json:"period,omitempty"`
	Archived bool          `json:"archived"`
	ViewLink string        `json:"viewLink"`
}

type ServerInfoResponse 

type ServerInfoResponse struct {
	Version                 string             `json:"version"`
	Onion                   string             `json:"onion"`
	SupportedPaymentMethods []string           `json:"supportedPaymentMethods"`
	FullySynched            bool               `json:"fullySynched"`
	SyncStatus              []ServerSyncStatus `json:"syncStatus"`
}

type ServerNodeInformation 

type ServerNodeInformation struct {
	Headers              int64   `json:"headers"`
	Blocks               int64   `json:"blocks"`
	VerificationProgress float64 `json:"verificationProgress"`
}

type ServerSyncStatus 

type ServerSyncStatus struct {
	CryptoCode      string                `json:"cryptoCode"`
	NodeInformation ServerNodeInformation `json:"nodeInformation,omitempty"`
	ChainHeight     int64                 `json:"chainHeight"`
	SyncHeight      int64                 `json:"syncHeight,omitempty"`
}

type SpeedPolicy 

type SpeedPolicy struct {
	HighSpeed      BTCPaySpeedPolicy
	MediumSpeed    BTCPaySpeedPolicy
	LowMediumSpeed BTCPaySpeedPolicy
	LowSpeed       BTCPaySpeedPolicy
}

func GetSpeedPolicy 

func GetSpeedPolicy() *SpeedPolicy

type Store 

type Store struct {
	ID     StoreID
	Client *Client
}

func (*Store) ApprovePayout 

func (s *Store) ApprovePayout(ctx context.Context, payoutID *PayoutID, payoutApproveRequest *PayoutApproveRequest) (*PayoutResponse, int, error)

func (*Store) ArchiveInvoice 

func (s *Store) ArchiveInvoice(ctx context.Context, invoiceID *InvoiceID) (int, error)

func (*Store) ArchivePaymentRequest 

func (s *Store) ArchivePaymentRequest(ctx context.Context, paymentRequestID *PaymentRequestID) (int, error)

func (*Store) ArchivePullPayment 

func (s *Store) ArchivePullPayment(ctx context.Context, pullPaymentID *PullPaymentID) (int, error)

func (*Store) CancelPayout 

func (s *Store) CancelPayout(ctx context.Context, payoutID *PayoutID) (int, error)

func (*Store) CreateInvoice 

func (s *Store) CreateInvoice(ctx context.Context, invoiceRequest *InvoiceRequest) (*InvoiceResponse, int, error)

func (*Store) CreatePaymentRequest 

func (s *Store) CreatePaymentRequest(ctx context.Context, paymentRequestRequest *PaymentRequestRequest) (*PaymentRequestResponse, int, error)

func (*Store) CreatePullPayment 

func (s *Store) CreatePullPayment(ctx context.Context, pullPaymentRequest *PullPaymentRequest) (*PullPaymentResponse, int, error)

func (*Store) GetInvoice 

func (s *Store) GetInvoice(ctx context.Context, invoiceID *InvoiceID) (*InvoiceResponse, int, error)

func (*Store) GetInvoicePaymentMethod 

func (s *Store) GetInvoicePaymentMethod(ctx context.Context, invoiceID *InvoiceID) ([]*InvoicePaymentMethodResponse, int, error)

func (*Store) GetInvoices 

func (s *Store) GetInvoices(ctx context.Context) ([]*InvoiceResponse, int, error)

func (*Store) GetPaymentRequest 

func (s *Store) GetPaymentRequest(ctx context.Context, paymentRequestID *PaymentRequestID) (*PaymentRequestResponse, int, error)

func (*Store) GetPaymentRequests 

func (s *Store) GetPaymentRequests(ctx context.Context) ([]*PaymentRequestResponse, int, error)

func (*Store) GetPullPayments 

func (s *Store) GetPullPayments(ctx context.Context, includeArchived ...bool) ([]*PullPaymentResponse, int, error)

func (*Store) GetStore 

func (s *Store) GetStore(ctx context.Context) (*StoreResponse, int, error)

func (*Store) MarkInvoiceStatus 

func (s *Store) MarkInvoiceStatus(ctx context.Context, invoiceID *InvoiceID, markInvoiceStatusRequest *MarkInvoiceStatusRequest) (*InvoiceResponse, int, error)

func (*Store) RemoveStore 

func (s *Store) RemoveStore(ctx context.Context) (int, error)

func (*Store) UnarchiveInvoice 

func (s *Store) UnarchiveInvoice(ctx context.Context, invoiceID *InvoiceID) (*InvoiceResponse, int, error)

func (*Store) UpdateInvoice 

func (s *Store) UpdateInvoice(ctx context.Context, invoiceID *InvoiceID, invoiceUpdate *InvoiceUpdate) (*InvoiceResponse, int, error)

func (*Store) UpdatePaymentRequest 

func (s *Store) UpdatePaymentRequest(ctx context.Context, paymentRequestID *PaymentRequestID, paymentRequestUpdate *PaymentRequestRequest) (*PaymentRequestResponse, int, error)

func (*Store) UpdateStore 

func (s *Store) UpdateStore(ctx context.Context, storeUpdate *StoreUpdate) (*StoreResponse, int, error)

type StoreID 

type StoreID string

type StoreRequest 

type StoreRequest struct {
	Name                         string               `json:"name"`
	Website                      string               `json:"website,omitempty"`
	InvoiceExpiration            int64                `json:"invoiceExpiration,omitempty"`
	MonitoringExpiration         int64                `json:"monitoringExpiration,omitempty"`
	SpeedPolicy                  BTCPaySpeedPolicy    `json:"speedPolicy,omitempty"`
	LightningDescriptionTemplate string               `json:"lightningDescriptionTemplate,omitempty"`
	PaymentTolerance             float64              `json:"paymentTolerance,omitempty"`
	AnyoneCanCreateInvoice       bool                 `json:"anyoneCanCreateInvoice,omitempty"`
	RequiresRefundEmail          bool                 `json:"requiresRefundEmail,omitempty"`
	LightningAmountInSatoshi     bool                 `json:"lightningAmountInSatoshi,omitempty"`
	LightningPrivateRouteHints   bool                 `json:"lightningPrivateRouteHints,omitempty"`
	OnChainWithLnInvoiceFallback bool                 `json:"onChainWithLnInvoiceFallback,omitempty"`
	RedirectAutomatically        bool                 `json:"redirectAutomatically,omitempty"`
	ShowRecommendedFee           bool                 `json:"showRecommendedFee,omitempty"`
	RecommendedFeeBlockTarget    int32                `json:"recommendedFeeBlockTarget,omitempty"`
	DefaultLang                  string               `json:"defaultLang,omitempty"`
	CustomCSS                    string               `json:"customCSS,omitempty"`
	HtmlTitle                    string               `json:"htmlTitle,omitempty"`
	NetworkFeeMode               BTCPayNetworkFeeMode `json:"networkFeeMode,omitempty"`
	PayJoinEnabled               bool                 `json:"payJoinEnabled,omitempty"`
	DefaultPaymentMethod         string               `json:"defaultPaymentMethod,omitempty"`
}

type StoreResponse 

type StoreResponse struct {
	Name                         string               `json:"name"`
	Website                      string               `json:"website"`
	InvoiceExpiration            int64                `json:"invoiceExpiration"`
	MonitoringExpiration         int64                `json:"monitoringExpiration"`
	SpeedPolicy                  BTCPaySpeedPolicy    `json:"speedPolicy"`
	LightningDescriptionTemplate string               `json:"lightningDescriptionTemplate,omitempty"`
	PaymentTolerance             float64              `json:"paymentTolerance"`
	AnyoneCanCreateInvoice       bool                 `json:"anyoneCanCreateInvoice"`
	RequiresRefundEmail          bool                 `json:"requiresRefundEmail"`
	LightningAmountInSatoshi     bool                 `json:"lightningAmountInSatoshi"`
	LightningPrivateRouteHints   bool                 `json:"lightningPrivateRouteHints"`
	OnChainWithLnInvoiceFallback bool                 `json:"onChainWithLnInvoiceFallback"`
	RedirectAutomatically        bool                 `json:"redirectAutomatically"`
	ShowRecommendedFee           bool                 `json:"showRecommendedFee"`
	RecommendedFeeBlockTarget    int32                `json:"recommendedFeeBlockTarget"`
	DefaultLang                  string               `json:"defaultLang"`
	CustomCSS                    string               `json:"customCSS,omitempty"`
	HtmlTitle                    string               `json:"htmlTitle,omitempty"`
	NetworkFeeMode               BTCPayNetworkFeeMode `json:"networkFeeMode"`
	PayJoinEnabled               bool                 `json:"payJoinEnabled"`
	DefaultPaymentMethod         string               `json:"defaultPaymentMethod"`
	ID                           StoreID              `json:"id"`
}

type StoreUpdate 

type StoreUpdate struct {
	Name                         string               `json:"name,omitempty"`
	Website                      string               `json:"website,omitempty"`
	InvoiceExpiration            int64                `json:"invoiceExpiration,omitempty"`
	MonitoringExpiration         int64                `json:"monitoringExpiration,omitempty"`
	SpeedPolicy                  BTCPaySpeedPolicy    `json:"speedPolicy,omitempty"`
	LightningDescriptionTemplate string               `json:"lightningDescriptionTemplate,omitempty"`
	PaymentTolerance             float64              `json:"paymentTolerance,omitempty"`
	AnyoneCanCreateInvoice       bool                 `json:"anyoneCanCreateInvoice,omitempty"`
	RequiresRefundEmail          bool                 `json:"requiresRefundEmail,omitempty"`
	LightningAmountInSatoshi     bool                 `json:"lightningAmountInSatoshi,omitempty"`
	LightningPrivateRouteHints   bool                 `json:"lightningPrivateRouteHints,omitempty"`
	OnChainWithLnInvoiceFallback bool                 `json:"onChainWithLnInvoiceFallback,omitempty"`
	RedirectAutomatically        bool                 `json:"redirectAutomatically,omitempty"`
	ShowRecommendedFee           bool                 `json:"showRecommendedFee,omitempty"`
	RecommendedFeeBlockTarget    int32                `json:"recommendedFeeBlockTarget,omitempty"`
	DefaultLang                  string               `json:"defaultLang,omitempty"`
	CustomCSS                    string               `json:"customCSS,omitempty"`
	HtmlTitle                    string               `json:"htmlTitle,omitempty"`
	NetworkFeeMode               BTCPayNetworkFeeMode `json:"networkFeeMode,omitempty"`
	PayJoinEnabled               bool                 `json:"payJoinEnabled,omitempty"`
	DefaultPaymentMethod         string               `json:"defaultPaymentMethod,omitempty"`
	ID                           StoreID              `json:"id,omitempty"`
}

type UpdateNotification 

type UpdateNotification struct {
	Seen bool `json:"seen"`
}

type UserID 

type UserID string

type UserRequest 

type UserRequest struct {
	Email           string `json:"email"`
	Password        string `json:"password"`
	IsAdministrator bool   `json:"isAdministrator"`
}

type UserResponse 

type UserResponse struct {
	ID                        UserID   `json:"id"`
	Email                     string   `json:"email"`
	EmailConfirmed            bool     `json:"emailConfirmed"`
	RequiresEmailConfirmation bool     `json:"requiresEmailConfirmation"`
	Created                   int64    `json:"created,omitempty"`
	Roles                     []string `json:"roles"`
}

Source Files

View all Source files

Directories

Path Synopsis
config

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.