driver005 / medusa-gateway

Go API client for openapi

A full API to use your BTCPay Server

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: v1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://btcpayserver.org

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://btcpay.example.com/api/v1

Class	Method	HTTP request	Description
APIKeysApi	ApiKeysCreateApiKey	Post /api/v1/api-keys	Create a new API Key
APIKeysApi	ApiKeysDeleteApiKey	Delete /api/v1/api-keys/{apikey}	Revoke an API Key
APIKeysApi	ApiKeysDeleteCurrentApiKey	Delete /api/v1/api-keys/current	Revoke the current API Key
APIKeysApi	ApiKeysGetCurrentApiKey	Get /api/v1/api-keys/current	Get the current API Key information
AppsApi	AppsCreatePointOfSaleApp	Post /api/v1/stores/{storeId}/apps/pos	Create a new Point of Sale app
AppsApi	AppsDeletePointOfSaleApp	Delete /api/v1/apps/{appId}	Delete app
AppsApi	AppsGetPointOfSaleApp	Get /api/v1/apps/{appId}	Get basic app data
AuthorizationApi	ApiKeysAuthorize	Get /api-keys/authorize	Authorize User
CustodiansApi	CustodiansAddStoreCustodianAccount	Post /api/v1/stores/{storeId}/custodian-accounts	Add a custodial account to a store.
CustodiansApi	CustodiansDeleteStoreCustodianAccount	Delete /api/v1/stores/{storeId}/custodian-accounts/{accountId}	Delete store custodian account
CustodiansApi	CustodiansGetStoreCustodianAccount	Get /api/v1/stores/{storeId}/custodian-accounts/{accountId}	Get store custodian account
CustodiansApi	CustodiansGetStoreCustodianAccountDepositAddress	Get /api/v1/stores/{storeId}/custodian-accounts/{accountId}/addresses/{paymentMethod}	Get a deposit address for custodian
CustodiansApi	CustodiansGetStoreCustodianAccountTradeQuote	Get /api/v1/stores/{storeId}/custodian-accounts/{accountId}/trades/quote	Get quote for trading one asset for another
CustodiansApi	CustodiansGetStoreCustodianAccountWithdrawalInfo	Post /api/v1/stores/{storeId}/custodian-accounts/{accountId}/withdrawals/{withdrawalId}	Get withdrawal info
CustodiansApi	CustodiansGetStoreCustodianAccounts	Get /api/v1/stores/{storeId}/custodian-accounts	List store custodian accounts
CustodiansApi	CustodiansGetSupportedCustodians	Get /api/v1/custodians	List supported custodians
CustodiansApi	CustodiansStoreCustodianAccountTradeMarket	Post /api/v1/stores/{storeId}/custodian-accounts/{accountId}/trades/market	Trade one asset for another
CustodiansApi	CustodiansUpdateStoreCustodianAccount	Put /api/v1/stores/{storeId}/custodian-accounts/{accountId}	Update custodial account
CustodiansApi	CustodiansWithdrawFromStoreCustodianAccount	Post /api/v1/stores/{storeId}/custodian-accounts/{accountId}/withdrawals	Withdraw to store wallet
HealthApi	HealthGetHealth	Get /api/v1/health	Get health status
InvoicesApi	InvoicesActivatePaymentMethod	Post /api/v1/stores/{storeId}/invoices/{invoiceId}/payment-methods/{paymentMethod}/activate	Activate Payment Method
InvoicesApi	InvoicesArchiveInvoice	Delete /api/v1/stores/{storeId}/invoices/{invoiceId}	Archive invoice
InvoicesApi	InvoicesCreateInvoice	Post /api/v1/stores/{storeId}/invoices	Create a new invoice
InvoicesApi	InvoicesGetInvoice	Get /api/v1/stores/{storeId}/invoices/{invoiceId}	Get invoice
InvoicesApi	InvoicesGetInvoicePaymentMethods	Get /api/v1/stores/{storeId}/invoices/{invoiceId}/payment-methods	Get invoice payment methods
InvoicesApi	InvoicesGetInvoices	Get /api/v1/stores/{storeId}/invoices	Get invoices
InvoicesApi	InvoicesMarkInvoiceStatus	Post /api/v1/stores/{storeId}/invoices/{invoiceId}/status	Mark invoice status
InvoicesApi	InvoicesUnarchiveInvoice	Post /api/v1/stores/{storeId}/invoices/{invoiceId}/unarchive	Unarchive invoice
InvoicesApi	InvoicesUpdateInvoice	Put /api/v1/stores/{storeId}/invoices/{invoiceId}	Update invoice
LNbankApi	ApiV1LnbankWalletsWalletIdDelete	Delete /api/v1/lnbank/wallets/{walletId}	Remove wallet
LNbankApi	LNbankWalletsCreateWallet	Post /api/v1/lnbank/wallets	Create a new wallet
LNbankApi	LNbankWalletsGetWallet	Get /api/v1/lnbank/wallets/{walletId}	Get wallet
LNbankApi	LNbankWalletsGetWallets	Get /api/v1/lnbank/wallets	Get wallets
LNbankApi	LNbankWalletsUpdateWallet	Put /api/v1/lnbank/wallets/{walletId}	Update wallet
LightningInternalNodeApi	InternalLightningNodeApiConnectToNode	Post /api/v1/server/lightning/{cryptoCode}/connect	Connect to lightning node
LightningInternalNodeApi	InternalLightningNodeApiCreateInvoice	Post /api/v1/server/lightning/{cryptoCode}/invoices	Create lightning invoice
LightningInternalNodeApi	InternalLightningNodeApiGetBalance	Get /api/v1/server/lightning/{cryptoCode}/balance	Get node balance
LightningInternalNodeApi	InternalLightningNodeApiGetChannels	Get /api/v1/server/lightning/{cryptoCode}/channels	Get channels
LightningInternalNodeApi	InternalLightningNodeApiGetDepositAddress	Post /api/v1/server/lightning/{cryptoCode}/address	Get deposit address
LightningInternalNodeApi	InternalLightningNodeApiGetInfo	Get /api/v1/server/lightning/{cryptoCode}/info	Get node information
LightningInternalNodeApi	InternalLightningNodeApiGetInvoice	Get /api/v1/server/lightning/{cryptoCode}/invoices/{id}	Get invoice
LightningInternalNodeApi	InternalLightningNodeApiGetPayment	Get /api/v1/server/lightning/{cryptoCode}/payments/{paymentHash}	Get payment
LightningInternalNodeApi	InternalLightningNodeApiOpenChannel	Post /api/v1/server/lightning/{cryptoCode}/channels	Open channel
LightningInternalNodeApi	InternalLightningNodeApiPayInvoice	Post /api/v1/server/lightning/{cryptoCode}/invoices/pay	Pay Lightning Invoice
LightningStoreApi	StoreLightningNodeApiConnectToNode	Post /api/v1/stores/{storeId}/lightning/{cryptoCode}/connect	Connect to lightning node
LightningStoreApi	StoreLightningNodeApiCreateInvoice	Post /api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices	Create lightning invoice
LightningStoreApi	StoreLightningNodeApiGetBalance	Get /api/v1/stores/{storeId}/lightning/{cryptoCode}/balance	Get node balance
LightningStoreApi	StoreLightningNodeApiGetChannels	Get /api/v1/stores/{storeId}/lightning/{cryptoCode}/channels	Get channels
LightningStoreApi	StoreLightningNodeApiGetDepositAddress	Post /api/v1/stores/{storeId}/lightning/{cryptoCode}/address	Get deposit address
LightningStoreApi	StoreLightningNodeApiGetInfo	Get /api/v1/stores/{storeId}/lightning/{cryptoCode}/info	Get node information
LightningStoreApi	StoreLightningNodeApiGetInvoice	Get /api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices/{id}	Get invoice
LightningStoreApi	StoreLightningNodeApiGetPayment	Get /api/v1/stores/{storeId}/lightning/{cryptoCode}/payments/{paymentHash}	Get payment
LightningStoreApi	StoreLightningNodeApiOpenChannel	Post /api/v1/stores/{storeId}/lightning/{cryptoCode}/channels	Open channel
LightningStoreApi	StoreLightningNodeApiPayInvoice	Post /api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices/pay	Pay Lightning Invoice
MiscelleneousApi	InvoiceCheckout	Get /i/{invoiceId}	Invoice checkout
MiscelleneousApi	LangCodes	Get /misc/lang	Language codes
MiscelleneousApi	PermissionsMetadata	Get /misc/permissions	Permissions metadata
NotificationsCurrentUserApi	NotificationsDeleteNotification	Delete /api/v1/users/me/notifications/{id}	Remove Notification
NotificationsCurrentUserApi	NotificationsGetNotification	Get /api/v1/users/me/notifications/{id}	Get notification
NotificationsCurrentUserApi	NotificationsGetNotifications	Get /api/v1/users/me/notifications	Get notifications
NotificationsCurrentUserApi	NotificationsUpdateNotification	Put /api/v1/users/me/notifications/{id}	Update notification
PaymentRequestsApi	PaymentRequestsArchivePaymentRequest	Delete /api/v1/stores/{storeId}/payment-requests/{paymentRequestId}	Archive payment request
PaymentRequestsApi	PaymentRequestsCreatePaymentRequest	Post /api/v1/stores/{storeId}/payment-requests	Create a new payment request
PaymentRequestsApi	PaymentRequestsGetPaymentRequest	Get /api/v1/stores/{storeId}/payment-requests/{paymentRequestId}	Get payment request
PaymentRequestsApi	PaymentRequestsGetPaymentRequests	Get /api/v1/stores/{storeId}/payment-requests	Get payment requests
PaymentRequestsApi	PaymentRequestsUpdatePaymentRequest	Put /api/v1/stores/{storeId}/payment-requests/{paymentRequestId}	Update payment request
PayoutProcessorsApi	PayoutProcessorsGetPayoutProcessors	Get /api/v1/payout-processors	Get payout processors
PullPaymentsManagementApi	PullPaymentsArchivePullPayment	Delete /api/v1/stores/{storeId}/pull-payments/{pullPaymentId}	Archive a pull payment
PullPaymentsManagementApi	PullPaymentsCreatePullPayment	Post /api/v1/stores/{storeId}/pull-payments	Create a new pull payment
PullPaymentsManagementApi	PullPaymentsGetPullPayments	Get /api/v1/stores/{storeId}/pull-payments	Get store's pull payments
PullPaymentsPayoutPublicApi	PullPaymentsGetPayout	Get /api/v1/pull-payments/{pullPaymentId}/payouts/{payoutId}	Get Payout
PullPaymentsPublicApi	PullPaymentsCreatePayout	Post /api/v1/pull-payments/{pullPaymentId}/payouts	Create Payout
PullPaymentsPublicApi	PullPaymentsGetPayout	Get /api/v1/pull-payments/{pullPaymentId}/payouts/{payoutId}	Get Payout
PullPaymentsPublicApi	PullPaymentsGetPayouts	Get /api/v1/pull-payments/{pullPaymentId}/payouts	Get Payouts
PullPaymentsPublicApi	PullPaymentsGetPullPayment	Get /api/v1/pull-payments/{pullPaymentId}	Get Pull Payment
ServerInfoApi	ServerInfoGetServerInfo	Get /api/v1/server/info	Get server info
StorePaymentMethodsApi	StorePaymentMethodsGetStorePaymentMethods	Get /api/v1/stores/{storeId}/payment-methods	Get store payment methods
StorePaymentMethodsLNURLPayApi	StoreLNURLPayPaymentMethodsDeleteLNURLPayPaymentMethod	Delete /api/v1/stores/{storeId}/payment-methods/LNURL/{cryptoCode}	Remove store LNURL Pay payment method
StorePaymentMethodsLNURLPayApi	StoreLNURLPayPaymentMethodsGetLNURLPayPaymentMethod	Get /api/v1/stores/{storeId}/payment-methods/LNURL/{cryptoCode}	Get store LNURL Pay payment method
StorePaymentMethodsLNURLPayApi	StoreLNURLPayPaymentMethodsGetLNURLPayPaymentMethods	Get /api/v1/stores/{storeId}/payment-methods/LNURL	Get store LNURL payment methods
StorePaymentMethodsLNURLPayApi	StoreLNURLPayPaymentMethodsUpdateLNURLPayPaymentMethod	Put /api/v1/stores/{storeId}/payment-methods/LNURL/{cryptoCode}	Update store LNURL Pay payment method
StorePaymentMethodsLightningNetworkApi	StoreLightningNetworkPaymentMethodsDeleteLightningNetworkPaymentMethod	Delete /api/v1/stores/{storeId}/payment-methods/LightningNetwork/{cryptoCode}	Remove store Lightning Network payment method
StorePaymentMethodsLightningNetworkApi	StoreLightningNetworkPaymentMethodsGetLightningNetworkPaymentMethod	Get /api/v1/stores/{storeId}/payment-methods/LightningNetwork/{cryptoCode}	Get store Lightning Network payment method
StorePaymentMethodsLightningNetworkApi	StoreLightningNetworkPaymentMethodsGetLightningNetworkPaymentMethods	Get /api/v1/stores/{storeId}/payment-methods/LightningNetwork	Get store Lightning Network payment methods
StorePaymentMethodsLightningNetworkApi	StoreLightningNetworkPaymentMethodsUpdateLightningNetworkPaymentMethod	Put /api/v1/stores/{storeId}/payment-methods/LightningNetwork/{cryptoCode}	Update store Lightning Network payment method
StorePaymentMethodsOnChainApi	StoreOnChainPaymentMethodsDeleteOnChainPaymentMethod	Delete /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}	Remove store on-chain payment method
StorePaymentMethodsOnChainApi	StoreOnChainPaymentMethodsGenerateOnChainWallet	Post /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/generate	Generate store on-chain wallet
StorePaymentMethodsOnChainApi	StoreOnChainPaymentMethodsGetOnChainPaymentMethod	Get /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}	Get store on-chain payment method
StorePaymentMethodsOnChainApi	StoreOnChainPaymentMethodsGetOnChainPaymentMethodPreview	Get /api/v1/stores/{storeId}/payment-methods/OnChain/{cryptoCode}/preview	Preview store on-chain payment method addresses
StorePaymentMethodsOnChainApi	StoreOnChainPaymentMethodsGetOnChainPaymentMethods	Get /api/v1/stores/{storeId}/payment-methods/OnChain	Get store on-chain payment methods
StorePaymentMethodsOnChainApi	StoreOnChainPaymentMethodsPOSTOnChainPaymentMethodPreview	Post /api/v1/stores/{storeId}/payment-methods/OnChain/{cryptoCode}/preview	Preview proposed store on-chain payment method addresses
StorePaymentMethodsOnChainApi	StoreOnChainPaymentMethodsUpdateOnChainPaymentMethod	Put /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}	Update store on-chain payment method
StoreWalletOnChainApi	StoreOnChainWalletsCreateOnChainTransaction	Post /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/transactions	Create store on-chain wallet transaction
StoreWalletOnChainApi	StoreOnChainWalletsGetOnChainFeeRate	Get /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/feerate	Get store on-chain wallet fee rate
StoreWalletOnChainApi	StoreOnChainWalletsGetOnChainWalletReceiveAddress	Get /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/address	Get store on-chain wallet address
StoreWalletOnChainApi	StoreOnChainWalletsGetOnChainWalletTransaction	Get /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/transactions/{transactionId}	Get store on-chain wallet transaction
StoreWalletOnChainApi	StoreOnChainWalletsGetOnChainWalletUTXOs	Get /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/utxos	Get store on-chain wallet UTXOS
StoreWalletOnChainApi	StoreOnChainWalletsPatchOnChainWalletTransaction	Patch /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/transactions/{transactionId}	Patch store on-chain wallet transaction info
StoreWalletOnChainApi	StoreOnChainWalletsShowOnChainWalletOverview	Get /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet	Get store on-chain wallet overview
StoreWalletOnChainApi	StoreOnChainWalletsShowOnChainWalletTransactions	Get /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/transactions	Get store on-chain wallet transactions
StoreWalletOnChainApi	StoreOnChainWalletsUnReserveOnChainWalletReceiveAddress	Delete /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/address	UnReserve last store on-chain wallet address
StoresApi	StoresCreateStore	Post /api/v1/stores	Create a new store
StoresApi	StoresDeleteStore	Delete /api/v1/stores/{storeId}	Remove Store
StoresApi	StoresGetStore	Get /api/v1/stores/{storeId}	Get store
StoresApi	StoresGetStores	Get /api/v1/stores	Get stores
StoresApi	StoresUpdateStore	Put /api/v1/stores/{storeId}	Update store
StoresEmailApi	StoresGetStoreEmailSettings	Get /api/v1/stores/{storeId}/email	Get store email settings
StoresEmailApi	StoresSendStoreEmail	Post /api/v1/stores/{storeId}/email/send	Send an email for a store
StoresEmailApi	StoresUpdateStoreEmailSettings	Put /api/v1/stores/{storeId}/email	Update store email settings
StoresPayoutProcessorsApi	GreenfieldStoreAutomatedLightningPayoutProcessorsControllerGetStoreLightningAutomatedPayoutProcessorsForPaymentMethod	Get /api/v1/stores/{storeId}/payout-processors/LightningAutomatedTransferSenderFactory/{paymentMethod}	Get configured store Lightning automated payout processors
StoresPayoutProcessorsApi	GreenfieldStoreAutomatedLightningPayoutProcessorsControllerGetStoreLightningAutomatedTransferSenderFactory	Get /api/v1/stores/{storeId}/payout-processors/LightningAutomatedTransferSenderFactory	Get configured store Lightning automated payout processors
StoresPayoutProcessorsApi	GreenfieldStoreAutomatedLightningPayoutProcessorsControllerUpdateStoreLightningAutomatedPayoutProcessor	Put /api/v1/stores/{storeId}/payout-processors/LightningAutomatedTransferSenderFactory/{paymentMethod}	Update configured store Lightning automated payout processors
StoresPayoutProcessorsApi	GreenfieldStoreAutomatedOnChainPayoutProcessorsControllerGetStoreOnChainAutomatedPayoutProcessorsForPaymentMethod	Get /api/v1/stores/{storeId}/payout-processors/OnChainAutomatedTransferSenderFactory/{paymentMethod}	Get configured store onchain automated payout processors
StoresPayoutProcessorsApi	GreenfieldStoreAutomatedOnChainPayoutProcessorsControllerGetStoreOnChainAutomatedTransferSenderFactory	Get /api/v1/stores/{storeId}/payout-processors/OnChainAutomatedTransferSenderFactory	Get configured store onchain automated payout processors
StoresPayoutProcessorsApi	GreenfieldStoreAutomatedOnChainPayoutProcessorsControllerUpdateStoreOnChainAutomatedPayoutProcessorForPaymentMethod	Put /api/v1/stores/{storeId}/payout-processors/OnChainAutomatedTransferSenderFactory/{paymentMethod}	Update configured store onchain automated payout processors
StoresPayoutProcessorsApi	GreenfieldStoreAutomatedOnChainPayoutProcessorsControllerUpdateStoreOnChainAutomatedTransferSenderFactory	Put /api/v1/stores/{storeId}/payout-processors/OnChainAutomatedTransferSenderFactory	Update configured store onchain automated payout processors
StoresPayoutProcessorsApi	StorePayoutProcessorsGetStorePayoutProcessors	Get /api/v1/stores/{storeId}/payout-processors	Get store configured payout processors
StoresPayoutProcessorsApi	StorePayoutProcessorsRemoveStorePayoutProcessor	Delete /api/v1/stores/{storeId}/payout-processors/{processor}/{paymentMethod}	Remove store configured payout processor
StoresPayoutsApi	PayoutsCreatePayoutThroughStore	Post /api/v1/stores/{storeId}/payouts	Create Payout
StoresPayoutsApi	PullPaymentsApprovePayout	Post /api/v1/stores/{storeId}/payouts/{payoutId}	Approve Payout
StoresPayoutsApi	PullPaymentsCancelPayout	Delete /api/v1/stores/{storeId}/payouts/{payoutId}	Cancel Payout
StoresPayoutsApi	PullPaymentsGetStorePayouts	Get /api/v1/stores/{storeId}/payouts	Get Store Payouts
StoresPayoutsApi	PullPaymentsMarkPayoutPaid	Post /api/v1/stores/{storeId}/payouts/{payoutId}/mark-paid	Mark Payout as Paid
StoresUsersApi	StoresAddStoreUser	Post /api/v1/stores/{storeId}/users	Add a store user
StoresUsersApi	StoresGetStoreUsers	Get /api/v1/stores/{storeId}/users	Get store users
StoresUsersApi	StoresRemoveStoreUser	Delete /api/v1/stores/{storeId}/users/{userId}	Remove Store User
UsersApi	UsersCreateUser	Post /api/v1/users	Create user
UsersApi	UsersDeleteCurrentUser	Delete /api/v1/users/me	Deletes user profile
UsersApi	UsersDeleteUser	Delete /api/v1/users/{idOrEmail}	Delete user
UsersApi	UsersGetCurrentUser	Get /api/v1/users/me	Get current user information
UsersApi	UsersGetUser	Get /api/v1/users/{idOrEmail}	Get user by ID or Email
UsersApi	UsersGetUsers	Get /api/v1/users	Get all users
UsersApi	UsersToggleUserLock	Delete /api/v1/users/{idOrEmail}/lock	Toggle user
WebhooksApi	WebhooksCreateWebhook	Post /api/v1/stores/{storeId}/webhooks	Create a new webhook
WebhooksApi	WebhooksDeleteWebhook	Delete /api/v1/stores/{storeId}/webhooks/{webhookId}	Delete a webhook
WebhooksApi	WebhooksGetWebhook	Get /api/v1/stores/{storeId}/webhooks/{webhookId}	Get a webhook of a store
WebhooksApi	WebhooksGetWebhookDeliveries	Get /api/v1/stores/{storeId}/webhooks/{webhookId}/deliveries	Get latest deliveries
WebhooksApi	WebhooksGetWebhookDelivery	Get /api/v1/stores/{storeId}/webhooks/{webhookId}/deliveries/{deliveryId}	Get a webhook delivery
WebhooksApi	WebhooksGetWebhookDeliveryRequests	Get /api/v1/stores/{storeId}/webhooks/{webhookId}/deliveries/{deliveryId}/request	Get the delivery's request
WebhooksApi	WebhooksGetWebhooks	Get /api/v1/stores/{storeId}/webhooks	Get webhooks of a store
WebhooksApi	WebhooksRedeliverWebhookDelivery	Post /api/v1/stores/{storeId}/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver	Redeliver the delivery
WebhooksApi	WebhooksUpdateWebhook	Put /api/v1/stores/{storeId}/webhooks/{webhookId}	Update a webhook

Documentation For Models

• ApiKeyData
• ApiKeysCreateApiKeyRequest
• ApplicationHealthData
• ApplicationServerInfoData
• ApplicationServerInfoNodeStatusData
• ApplicationServerInfoSyncStatusData
• ApplicationUserData
• AppsCreatePointOfSaleAppRequest
• AssetBalanceData
• AssetPairData
• BasicAppData
• CheckoutOptions
• ConnectToNodeRequest
• CreateCustodianAccountRequest
• CreateInvoiceRequest
• CreateInvoiceRequestAllOf
• CreateLightningInvoiceRequest
• CreateOnChainTransactionRequest
• CreateOnChainTransactionRequestDestination
• CreatePayoutRequest
• CreatePayoutThroughStoreRequest
• CreatePayoutThroughStoreRequestAllOf
• CustodianAccountData
• CustodianData
• CustodiansGetStoreCustodianAccountDepositAddress200Response
• CustodiansWithdrawFromStoreCustodianAccount403Response
• EmailData
• EmailSettingsData
• GenerateOnChainWalletRequest
• GenericPaymentMethodData
• GenericPaymentMethodDataData
• InvoiceAdditionalStatus
• InvoiceData
• InvoiceDataAllOf
• InvoiceDataBase
• InvoiceMetadata
• InvoiceMetadataAnyOf
• InvoiceMetadataAnyOf1
• InvoiceMetadataAnyOf10
• InvoiceMetadataAnyOf11
• InvoiceMetadataAnyOf12
• InvoiceMetadataAnyOf13
• InvoiceMetadataAnyOf14
• InvoiceMetadataAnyOf2
• InvoiceMetadataAnyOf3
• InvoiceMetadataAnyOf4
• InvoiceMetadataAnyOf5
• InvoiceMetadataAnyOf6
• InvoiceMetadataAnyOf7
• InvoiceMetadataAnyOf8
• InvoiceMetadataAnyOf9
• InvoicePaymentMethodDataModel
• InvoicePaymentMethodDataModelAdditionalData
• InvoicePaymentMethodDataModelAdditionalDataAnyOf
• InvoiceStatus
• InvoiceStatusMark
• InvoiceType
• LNURLPayPaymentMethodBaseData
• LNURLPayPaymentMethodData
• LNURLPayPaymentMethodDataAllOf
• LNbankEditWalletRequest
• LNbankWalletData
• LabelData
• LangCodes200ResponseInner
• LedgerEntryData
• LightningAutomatedTransferSettings
• LightningChannelData
• LightningInvoiceData
• LightningInvoiceStatus
• LightningNetworkPaymentMethodBaseData
• LightningNetworkPaymentMethodData
• LightningNetworkPaymentMethodDataAllOf
• LightningNodeBalanceData
• LightningNodeInformationData
• LightningPaymentData
• LightningPaymentStatus
• LockUserRequest
• MarkInvoiceStatusRequest
• NetworkFeeMode
• NotificationData
• OffchainBalanceData
• OnChainAutomatedTransferSettings
• OnChainPaymentMethodBaseData
• OnChainPaymentMethodData
• OnChainPaymentMethodDataAllOf
• OnChainPaymentMethodDataPreview
• OnChainPaymentMethodDataPreviewAllOf
• OnChainPaymentMethodDataWithSensitiveData
• OnChainPaymentMethodDataWithSensitiveDataAllOf
• OnChainPaymentMethodPreviewResultAddressItem
• OnChainPaymentMethodPreviewResultData
• OnChainWalletAddressData
• OnChainWalletFeeRateData
• OnChainWalletOverviewData
• OnChainWalletTransactionData
• OnChainWalletUTXOData
• OnchainBalanceData
• OpenLightningChannelRequest
• PatchOnChainTransactionRequest
• PayLightningInvoiceRequest
• Payment
• PaymentRequestBaseData
• PaymentRequestData
• PaymentRequestDataAllOf
• PaymentStatus
• PayoutData
• PayoutProcessorData
• PermissionsMetadata200ResponseInner
• PointOfSaleAppData
• ProblemDetails
• PullPaymentData
• PullPaymentsApprovePayoutRequest
• PullPaymentsCreatePullPaymentRequest
• QuoteResultData
• ReceiptOptions
• SpeedPolicy
• StoreBaseData
• StoreData
• StoreDataAllOf
• StoreOnChainPaymentMethodsPOSTOnChainPaymentMethodPreviewRequest
• StoreOnChainWalletsCreateOnChainTransaction200Response
• StoreUserData
• StoreUserDataAllOf
• TimeSpanMinutes
• TimeSpanSeconds
• TradeRequestData
• TradeRequestDataQty
• TradeResultData
• TransactionStatus
• UpdateInvoiceRequest
• UpdateLightningAutomatedTransferSettings
• UpdateLightningNetworkPaymentMethodRequest
• UpdateLightningNetworkPaymentMethodRequestAllOf
• UpdateNotification
• UpdateOnChainAutomatedTransferSettings
• UpdateOnChainPaymentMethodRequest
• UsersCreateUserRequest
• ValidationProblemDetailsInner
• WebhookData
• WebhookDataAllOf
• WebhookDataBase
• WebhookDataBaseAuthorizedEvents
• WebhookDataCreate
• WebhookDataCreateAllOf
• WebhookDataUpdate
• WebhookDataUpdateAllOf
• WebhookDeliveryData
• WebhookEvent
• WebhookInvoiceEvent
• WebhookInvoiceEventAllOf
• WebhookInvoiceExpiredEvent
• WebhookInvoiceExpiredEventAllOf
• WebhookInvoiceInvalidEvent
• WebhookInvoiceInvalidEventAllOf
• WebhookInvoicePaymentSettledEvent
• WebhookInvoiceProcessingEvent
• WebhookInvoiceReceivedPaymentEvent
• WebhookInvoiceReceivedPaymentEventAllOf
• WebhookInvoiceSettledEvent
• WebhookInvoiceSettledEventAllOf
• WebhookInvoiceSettledEventAllOf1
• WithdrawalRequestData
• WithdrawalResultData

Documentation For Authorization

API_Key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Basic

• Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author