model

type APIToken struct {

	// CreatedAt
	// Required: true
	// Format: datetime
	CreatedAt strfmt.DateTime `json:"createdAt"`

	// token UUID
	// Example: 1eb5fbb5-ece0-475c-9ddd-23c524a33e06
	// Required: true
	ID string `json:"id"`

	// Name
	// Example: My Token
	// Required: true
	Name string `json:"name"`

	// Token
	// Example: abc123
	// Required: true
	Token *string `json:"token"`
}

type AdditionalPaymentInfo struct {

	// Customer's Email
	// Example: user@gmail.com
	// Required: true
	CustomerEmail *string `json:"customerEmail"`

	// Customer's selected crypto currency
	// Example: USDT (Ethereum)
	// Required: true
	SelectedCurrency *string `json:"selectedCurrency"`

	// Service fee in customer's selected crypto currency
	// Example: 1.20
	// Required: true
	ServiceFee *string `json:"serviceFee"`
}

type AdditionalWithdrawalInfo struct {

	// Address UUID
	// Example: dac3a5f5-abc1-4bb2-97e7-db51360e218c
	// Required: true
	AddressID string `json:"addressId"`

	// Balance UUID
	// Example: 918c5aa6-bdad-4cc8-8aa0-de059c618a05
	// Required: true
	BalanceID string `json:"balanceId"`

	// Link to blockchain explorer
	// Example: https://etherscan.io/tx/0xdf147859a6e66961326ac91f4bd5e9980432040031e5eb7108603d51b81ae005
	// Required: true
	ExplorerLink *string `json:"explorerLink"`

	// Withdrawal Fee
	// Example: 1.20
	// Required: true
	ServiceFee string `json:"serviceFee"`

	// Transaction Hash
	// Example: 0xdf147859a6e66961326ac91f4bd5e9980432040031e5eb7108603d51b81ae005
	// Required: true
	TransactionHash *string `json:"transactionHash"`
}

type AvailableProvidersResponse struct {

	// providers
	Providers []*Provider `json:"providers"`
}

type Conversion struct {

	// Converted amount
	// Example: 0.066
	ConvertedAmount string `json:"convertedAmount,omitempty"`

	// Conversion rate
	// Example: 1820.5
	ExchangeRate float64 `json:"exchangeRate,omitempty"`

	// Selected ticker
	// Example: USD
	From string `json:"from,omitempty"`

	// Selected ticker type
	// Enum: [fiat crypto]
	FromType string `json:"fromType,omitempty"`

	// Selected amount
	// Example: 123
	SelectedAmount string `json:"selectedAmount,omitempty"`

	// Desired ticket
	// Example: ETH
	To string `json:"to,omitempty"`

	// Desired ticker type
	// Enum: [fiat crypto]
	ToType string `json:"toType,omitempty"`
}

type CreateMerchantAddressRequest struct {

	// address
	// Example: 0xdc22Bb64132fB03467910fc49595F08fCf5C241b
	// Required: true
	// Max Length: 128
	Address string `json:"address"`

	// blockchain
	// Example: ETH
	// Required: true
	// Enum: [BTC ETH TRON MATIC BSC]
	Blockchain string `json:"blockchain"`

	// Name
	// Example: My Wallet
	// Required: true
	// Max Length: 128
	// Min Length: 2
	Name string `json:"name"`
}

type CreateMerchantRequest struct {

	// Name
	// Example: My Store
	// Required: true
	// Max Length: 128
	// Min Length: 2
	Name string `json:"name"`

	// Website URL
	// Example: https://my-store.com
	// Required: true
	// Max Length: 255
	// Min Length: 2
	Website string `json:"website"`
}

type CreateMerchantTokenRequest struct {

	// Name
	// Example: My Token
	// Required: true
	// Max Length: 128
	// Min Length: 2
	Name string `json:"name"`
}

type CreatePaymentLinkRequest struct {

	// Fiat ticker for payment template.
	// Required: true
	// Enum: [USD EUR]
	Currency string `json:"currency"`

	// Optional payment description visible for a customer in payment screen
	// Example: White T-shirt size M
	Description *string `json:"description"`

	// Name
	// Example: My Link
	// Required: true
	// Max Length: 64
	// Min Length: 4
	Name string `json:"name"`

	// Price in fiat currency
	// Example: 29.9
	// Required: true
	// Minimum: 0.01
	Price float64 `json:"price"`

	// Redirect URL after successful customer's payment
	// Example: https://my-site.com/success?order=abc123
	RedirectURL *string `json:"redirectUrl"`

	// Action type after OxygenPay receives incoming payment from a customer.
	// - `redirectUrl` displays "Back to site" button with provided .redirectUrl.
	// - `showMessage` displays "Show message" with content provided in .successMessage.
	//
	// Required: true
	// Enum: [redirect showMessage]
	SuccessAction string `json:"successAction"`

	// message after successful customer's payment
	// Example: Thank you!
	// Max Length: 250
	// Min Length: 4
	SuccessMessage *string `json:"successMessage"`
}

type CreatePaymentRequest struct {

	// Fiat currency
	// Required: true
	// Enum: [USD EUR]
	Currency string `json:"currency"`

	// Optional payment description
	// Example: White T-shirt size M
	// Max Length: 128
	Description *string `json:"description,omitempty"`

	// To provide request idempotency order UUID should be generated on your side.
	// Should be unique for each payment
	//
	// Example: 123e4567-e89b-12d3-a456-426655440000
	// Required: true
	// Format: uuid
	ID strfmt.UUID `json:"id"`

	// Indicates that this is a test payment.
	// Test payments are processed in testnets (e.g. Ethereum Goerli)
	//
	IsTest bool `json:"isTest,omitempty"`

	// Optional order ID from your internal system
	// Example: customer#123#order#456
	OrderID *string `json:"orderId"`

	// Price in fiat currency
	// Example: 29.9
	// Required: true
	// Minimum: 0.01
	Price float64 `json:"price"`

	// A "back to store" button URL. Visible to a customer after the system receives unconfirmed transaction.
	// If not provided, defaults to merchant's website url.
	//
	// Example: https://my-store.com/success
	RedirectURL *string `json:"redirectUrl"`
}

type CreateWithdrawalRequest struct {

	// Address UUID
	// Example: ABF75267-910D-4FC8-9E21-3A3B48509DC2
	// Required: true
	AddressID string `json:"addressId"`

	// Withdrawal amount as string
	// Example: 0.0367
	// Required: true
	Amount string `json:"amount"`

	// Balance UUID
	// Example: 2402782A-711D-4ECD-8B73-FE561EBF5FEC
	// Required: true
	BalanceID string `json:"balanceId"`
}

type CurrencyExchangeRate struct {

	// crypto amount
	// Example: 0.1231232453453
	// Required: true
	CryptoAmount string `json:"cryptoAmount"`

	// crypto currency
	// Example: DAI
	// Required: true
	CryptoCurrency string `json:"cryptoCurrency"`

	// display name
	// Example: USD → ETH_DAI
	// Required: true
	DisplayName string `json:"displayName"`

	// exchange rate
	// Example: 51.1
	// Required: true
	ExchangeRate float64 `json:"exchangeRate"`

	// fiat amount
	// Example: 49.9
	// Required: true
	// Minimum: 0.01
	FiatAmount float64 `json:"fiatAmount"`

	// fiat currency
	// Example: USD
	// Required: true
	FiatCurrency string `json:"fiatCurrency"`

	// network
	// Example: ETH
	// Required: true
	Network string `json:"network"`
}

type Customer struct {

	// CreatedAt
	// Format: datetime
	CreatedAt strfmt.DateTime `json:"createdAt,omitempty"`

	// details
	Details *CustomerDetails `json:"details,omitempty"`

	// Email
	// Example: customer@example.com
	Email string `json:"email,omitempty"`

	// Customer UUID
	// Example: A9B04890-7FB9-42C6-A63B-9163968E4580
	ID string `json:"id,omitempty"`
}

type CustomerDetails struct {

	// payments
	Payments []*CustomerPayment `json:"payments"`

	// Number of successful payments
	SuccessfulPayments int64 `json:"successfulPayments"`
}

type CustomerPayment struct {

	// Created timestamp
	// Example: 2022-11-23 19:49:21.386201 +0000 UTC
	// Format: datetime
	CreatedAt strfmt.DateTime `json:"createdAt,omitempty"`

	// Fiat currency
	// Enum: [USD EUR]
	Currency string `json:"currency,omitempty"`

	// Order UUID
	// Example: 123e4567-e89b-12d3-a456-426655440000
	ID string `json:"id,omitempty"`

	// Payment price
	// Example: 29.9
	Price string `json:"price,omitempty"`

	// Payment status
	// Enum: [pending inProgress success failed]
	Status string `json:"status,omitempty"`
}

type CustomersPagination struct {

	// cursor
	// Example: 8c857501-e67d-4a0b-98d9-46e461b42c09
	// Required: true
	Cursor string `json:"cursor"`

	// limit
	// Example: 50
	// Required: true
	Limit int64 `json:"limit"`

	// results
	// Required: true
	Results []*Customer `json:"results"`
}

type ErrorResponse struct {

	// Errors list
	Errors []*ErrorResponseItem `json:"errors,omitempty"`

	// Error Message
	// Example: Error message
	Message string `json:"message,omitempty"`

	// Error status
	// Example: something_wrong
	Status string `json:"status,omitempty"`
}

type ErrorResponseItem struct {

	// Error field
	// Example: field
	Field string `json:"field,omitempty"`

	// Error Message
	// Example: Error message
	Message string `json:"message,omitempty"`
}

type ExchangeRate struct {

	// Converted amount
	// Example: 0.066
	ConvertedAmount string `json:"convertedAmount,omitempty"`

	// Conversion rate
	ExchangeRate float64 `json:"exchangeRate,omitempty"`

	// Selected ticker
	// Example: USD
	From string `json:"from,omitempty"`

	// Selected ticker type
	// Enum: [fiat crypto]
	FromType string `json:"fromType,omitempty"`

	// Selected amount
	// Example: 123
	SelectedAmount string `json:"selectedAmount,omitempty"`

	// Desired ticket
	// Example: ETH
	To string `json:"to,omitempty"`

	// Desired ticker type
	// Enum: [fiat crypto]
	ToType string `json:"toType,omitempty"`
}

type FormRequest struct {

	// Message
	// Example: Hey! Do you support USDC?
	// Required: true
	// Min Length: 1
	Message *string `json:"message"`

	// Form Topic
	// Example: Support
	// Required: true
	// Min Length: 4
	Topic *string `json:"topic"`
}

type LoginRequest struct {

	// Email
	// Required: true
	// Format: email
	Email strfmt.Email `json:"email"`

	// Password
	// Required: true
	// Min Length: 8
	Password string `json:"password"`
}

type Merchant struct {

	// merchant UUID
	// Example: 1eb5fbb5-ece0-475c-9ddd-23c524a33e06
	ID string `json:"id,omitempty"`

	// Name
	// Example: My Store
	Name string `json:"name,omitempty"`

	// supported payment methods
	SupportedPaymentMethods []*SupportedPaymentMethod `json:"supportedPaymentMethods"`

	// webhook settings
	WebhookSettings *WebhookSettings `json:"webhookSettings"`

	// Website URL
	// Example: https://my-store.com
	Website string `json:"website,omitempty"`
}

type MerchantAddress struct {

	// address
	// Example: 0xdc22Bb64132fB03467910fc49595F08fCf5C241b
	// Max Length: 128
	Address string `json:"address"`

	// blockchain
	// Example: ETH
	// Enum: [ETH TRON MATIC BSC]
	Blockchain string `json:"blockchain"`

	// Blockchain name
	// Example: Ethereum
	BlockchainName string `json:"blockchainName,omitempty"`

	// Address UUID
	// Example: 123e4567-e89b-12d3-a456-426655440000
	ID string `json:"id"`

	// Name
	// Example: My Wallet
	// Max Length: 128
	// Min Length: 2
	Name string `json:"name"`
}

type MerchantAddressList struct {

	// results
	Results []*MerchantAddress `json:"results"`
}

type MerchantBalance struct {

	// Assets amount in balance currency
	// Example: 50.40
	Amount string `json:"amount"`

	// Blockchain network
	// Example: ETH
	Blockchain string `json:"blockchain"`

	// Blockchain name
	// Example: Ethereum
	BlockchainName string `json:"blockchainName"`

	// Currency name
	// Example: USDT
	Currency string `json:"currency"`

	// Balance identifier
	// Example: 123e4567-e89b-12d3-a456-426655440000
	ID string `json:"id"`

	// Indicates whether balance is test or not
	IsTest bool `json:"isTest"`

	// Minimal withdrawal amount in USD
	// Example: 50
	MinimalWithdrawalAmountUSD string `json:"minimalWithdrawalAmountUSD"`

	// Balance name
	// Example: USDT (Ethereum)
	Name string `json:"name"`

	// Currency ticker
	// Example: ETH_USDT
	Ticker string `json:"ticker"`

	// Assets amount in USD
	// Example: 50.40
	UsdAmount string `json:"usdAmount"`
}

type MerchantBalanceList struct {

	// results
	Results []*MerchantBalance `json:"results"`
}

type MerchantList struct {

	// results
	// Required: true
	Results []*MerchantListItem `json:"results"`
}

type MerchantListItem struct {

	// merchant UUID
	// Example: 1eb5fbb5-ece0-475c-9ddd-23c524a33e06
	ID string `json:"id,omitempty"`

	// Name
	// Example: My Store
	Name string `json:"name,omitempty"`

	// Website URL
	// Example: https://my-store.com
	Website string `json:"website,omitempty"`
}

type Payment struct {

	// additional info
	AdditionalInfo *PaymentAdditionalInfo `json:"additionalInfo,omitempty"`

	// Created timestamp
	// Example: 2022-11-23 19:49:21.386201 +0000 UTC
	// Required: true
	// Format: datetime
	CreatedAt strfmt.DateTime `json:"createdAt"`

	// Fiat ticker for payments and crypto for withdrawals
	//
	// Example: USD
	// Required: true
	Currency string `json:"currency"`

	// Optional payment description that customer will see in payment screen
	// Example: White T-shirt size M
	Description *string `json:"description"`

	// Order UUID generated on your side
	// Example: 123e4567-e89b-12d3-a456-426655440000
	// Required: true
	ID string `json:"id"`

	// Indicates that this is a test payment.
	// Test payments are processed in testnets (e.g. Ethereum Goerli)
	//
	// Required: true
	IsTest bool `json:"isTest"`

	// Optional order ID from your system.
	// Example: order#123
	OrderID *string `json:"orderId"`

	// URL for client payment screen
	// Example: https://pay.o2pay.co/payment/00000000-0000-0000-0000-000000000000
	PaymentURL string `json:"paymentUrl"`

	// Payment price or withdrawal amount
	// Example: 29.9
	// Required: true
	Price string `json:"price"`

	// Redirect URL after success client's payment
	// Example: https://my-site.com/success?order=abc123
	RedirectURL string `json:"redirectUrl"`

	// Payment status
	// Required: true
	// Enum: [pending inProgress success failed]
	Status string `json:"status"`

	// Payment type
	// Required: true
	// Enum: [payment withdrawal]
	Type string `json:"type"`
}

type PaymentAdditionalInfo struct {

	// payment
	Payment *AdditionalPaymentInfo `json:"payment,omitempty"`

	// withdrawal
	Withdrawal *AdditionalWithdrawalInfo `json:"withdrawal,omitempty"`
}

type PaymentLink struct {

	// Created At timestamp
	// Example: 2022-11-23 19:49:21.386201 +0000 UTC
	// Required: true
	// Format: datetime
	CreatedAt strfmt.DateTime `json:"createdAt"`

	// Fiat ticker for payment template.
	// Required: true
	// Enum: [USD EUR]
	Currency string `json:"currency"`

	// Optional payment description visible for a customer in payment screen
	// Example: White T-shirt size M
	Description *string `json:"description"`

	// Link's UUID
	// Example: 123e4567-e89b-12d3-a456-426655440000
	// Required: true
	ID string `json:"id"`

	// Name
	// Example: My Link
	// Required: true
	Name string `json:"name"`

	// Payment price
	// Example: 29.9
	// Required: true
	Price string `json:"price"`

	// Redirect URL after successful customer's payment
	// Example: https://my-site.com/success?order=abc123
	RedirectURL *string `json:"redirectUrl"`

	// Action type after OxygenPay receives incoming payment from a customer.
	// - `redirectUrl` displays "Back to site" button with provided .redirectUrl.
	// - `showMessage` displays "Show message" with content provided in .successMessage.
	//
	// Required: true
	// Enum: [redirect showMessage]
	SuccessAction string `json:"successAction"`

	// message after successful customer's payment
	SuccessMessage *string `json:"successMessage"`

	// Link's URL
	// Example: https://pay.o2pay.co/link/ufaiCu6J
	// Required: true
	URL string `json:"url"`
}

type PaymentLinksPagination struct {

	// results
	// Required: true
	Results []*PaymentLink `json:"results"`
}

type PaymentsPagination struct {

	// cursor
	// Example: 8c857501-e67d-4a0b-98d9-46e461b42c09
	// Required: true
	Cursor string `json:"cursor"`

	// limit
	// Example: 50
	// Required: true
	Limit int64 `json:"limit"`

	// results
	// Required: true
	Results []*Payment `json:"results"`
}

type Provider struct {

	// name
	// Enum: [google email]
	Name string `json:"name,omitempty"`
}

type SupportedPaymentMethod struct {

	// Blockchain ticker
	// Example: ETH
	Blockchain string `json:"blockchain"`

	// blockchain name
	// Example: Ethereum
	BlockchainName string `json:"blockchainName"`

	// Display Name
	// Example: USDT (Ethereum)
	DisplayName string `json:"displayName"`

	// enabled
	// Example: true
	Enabled bool `json:"enabled"`

	// Coin / Token Name
	// Example: USDT
	Name string `json:"name"`

	// ticker
	// Example: ETH_USDT
	Ticker string `json:"ticker"`
}

type TokenList struct {

	// results
	// Required: true
	Results []*APIToken `json:"results"`
}

type UpdateMerchantAddressRequest struct {

	// Name
	// Example: My Wallet
	// Required: true
	// Max Length: 128
	// Min Length: 2
	Name string `json:"name"`
}

type UpdateMerchantRequest struct {

	// Name
	// Example: My Store
	// Required: true
	// Max Length: 128
	// Min Length: 2
	Name string `json:"name"`

	// Website URL
	// Example: https://my-store.com
	// Required: true
	// Max Length: 255
	// Min Length: 2
	Website string `json:"website"`
}

type UpdateSupportedPaymentMethodsRequest struct {

	// supported payment methods
	// Required: true
	// Min Items: 1
	SupportedPaymentMethods []string `json:"supportedPaymentMethods"`
}

type User struct {

	// Email
	// Example: user@example.com
	Email string `json:"email,omitempty"`

	// Name
	// Example: John Doe
	Name string `json:"name,omitempty"`

	// user avatar
	// Example: https://site.com/image.jpeg
	ProfileImageURL *string `json:"profileImageUrl,omitempty"`

	// user UUID
	// Example: 1eb5fbb5-ece0-475c-9ddd-23c524a33e06
	UUID string `json:"uuid,omitempty"`
}

type WebhookSettings struct {

	// HMAC secret for checking webhook signature
	// Example: xa9iZoo6
	// Max Length: 128
	Secret string `json:"secret"`

	// Webhook URL
	// Example: https://my-site.com/webhook/oxygen-pay
	// Required: true
	URL string `json:"url"`
}

type Withdrawal struct {

	// Payment UUID
	// Example: A9B04890-7FB9-42C6-A63B-9163968E4580
	PaymentID string `json:"paymentId,omitempty"`
}

type WithdrawalFee struct {

	// Blockchain
	// Example: ETH
	Blockchain string `json:"blockchain"`

	// calculated at
	// Example: 2023-04-06 19:56:39.358834 +0000 UTC
	// Format: datetime
	CalculatedAt strfmt.DateTime `json:"calculatedAt"`

	// Currency
	// Example: ETH_USDT
	Currency string `json:"currency"`

	// Fee in withdrawal currency
	// Example: 5.75
	CurrencyFee string `json:"currencyFee"`

	// Indicates whether currency is on testnet
	IsTest bool `json:"isTest"`

	// USD fee
	// Example: 5.68
	UsdFee string `json:"usdFee"`
}