transactions

type AmountEvent = shared.AmountEvent

type CardResponse struct {
	// Last 4 digits of the payment card number.
	// Read only
	// Min length: 4
	// Max length: 4
	Last4Digits *string `json:"last_4_digits,omitempty"`
	// Issuing card network of the payment card used for the transaction.
	Type *shared.CardType `json:"type,omitempty"`
}

type CardType = shared.CardType

type Client struct {
	// contains filtered or unexported fields
}

type Currency = shared.Currency

type EntryMode = shared.EntryMode

type EntryModeFilter string

type Event struct {
	// Amount of the event.
	Amount *shared.AmountEvent `json:"amount,omitempty"`
	// Amount deducted for the event.
	DeductedAmount *float32 `json:"deducted_amount,omitempty"`
	// Amount of the fee deducted for the event.
	DeductedFeeAmount *float32 `json:"deducted_fee_amount,omitempty"`
	// Amount of the fee related to the event.
	FeeAmount *float32 `json:"fee_amount,omitempty"`
	// Unique ID of the transaction event.
	// Format: int64
	ID *shared.EventID `json:"id,omitempty"`
	// Consecutive number of the installment.
	InstallmentNumber *int `json:"installment_number,omitempty"`
	// Status of the transaction event.
	Status *shared.EventStatus `json:"status,omitempty"`
	// Date and time of the transaction event.
	Timestamp *shared.TimestampEvent `json:"timestamp,omitempty"`
	// Unique ID of the transaction.
	TransactionID *shared.TransactionID `json:"transaction_id,omitempty"`
	// Type of the transaction event.
	Type *shared.EventType `json:"type,omitempty"`
}

type EventID = shared.EventID

type EventStatus = shared.EventStatus

type EventType = shared.EventType

type GetDeprecatedParams struct {
	// Retrieves the transaction resource with the specified transaction ID (the `id` parameter in the transaction resource).
	ID *string
	// Retrieves the transaction resource with the specified internal transaction ID (the `internal_id` parameter in
	// the transaction resource).
	InternalID *string
	// Retrieves the transaction resource with the specified transaction code.
	TransactionCode *string
}

type GetParams struct {
	// Client transaction id.
	ClientTransactionID *string
	// External/foreign transaction id (passed by clients).
	ForeignTransactionID *string
	// Retrieves the transaction resource with the specified transaction ID (the `id` parameter in the transaction resource).
	ID *string
	// Retrieves the transaction resource with the specified internal transaction ID (the `internal_id` parameter in
	// the transaction resource).
	InternalID *string
	// Retrieves the transaction resource with the specified transaction code.
	TransactionCode *string
}

type HorizontalAccuracy float32

type Lat float32

type Link struct {
	// URL for accessing the related resource.
	// Format: uri
	Href *string `json:"href,omitempty"`
	// Specifies the relation to the current resource.
	Rel *string `json:"rel,omitempty"`
	// Specifies the media type of the related resource.
	Type *string `json:"type,omitempty"`
}

type LinkRefund struct {
	// URL for accessing the related resource.
	// Format: uri
	Href *string `json:"href,omitempty"`
	// Maximum allowed amount for the refund.
	MaxAmount *float32 `json:"max_amount,omitempty"`
	// Minimum allowed amount for the refund.
	MinAmount *float32 `json:"min_amount,omitempty"`
	// Specifies the relation to the current resource.
	Rel *string `json:"rel,omitempty"`
	// Specifies the media type of the related resource.
	Type *string `json:"type,omitempty"`
}

type ListDeprecatedParams struct {
	// Filters the results by the latest modification time of resources and returns only transactions that are modified
	// *at or after* the specified timestamp (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
	ChangesSince *time.Time
	// Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will
	// return 10 results.
	Limit *int
	// Filters the results by the reference ID of transaction events and returns only transactions with events whose
	// IDs are *smaller* than the specified value. This parameters supersedes the `newest_time` parameter (if both
	// are provided in the request).
	NewestRef *string
	// Filters the results by the creation time of resources and returns only transactions that are created *before*
	// the specified timestamp (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
	NewestTime *time.Time
	// Filters the results by the reference ID of transaction events and returns only transactions with events whose
	// IDs are *greater* than the specified value. This parameters supersedes the `oldest_time` parameter (if both
	// are provided in the request).
	OldestRef *string
	// Filters the results by the creation time of resources and returns only transactions that are created *at
	// or after* the specified timestamp (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
	OldestTime *time.Time
	// Specifies the order in which the returned results are displayed.
	Order *string
	// Filters the returned results by the specified list of payment types used for the transactions.
	PaymentTypes []shared.PaymentType
	// Filters the returned results by the specified list of final statuses of the transactions.
	Statuses []string
	// Retrieves the transaction resource with the specified transaction code.
	TransactionCode *string
	// Filters the returned results by the specified list of transaction types.
	Types []string
	// Filters the returned results by user email.
	Users []string
}

type ListParams struct {
	// Filters the results by the latest modification time of resources and returns only transactions that are modified
	// *at or after* the specified timestamp (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
	ChangesSince *time.Time
	// Filters the returned results by the specified list of entry modes.
	EntryModes []EntryModeFilter
	// Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will
	// return 10 results.
	Limit *int
	// Filters the results by the reference ID of transaction events and returns only transactions with events whose
	// IDs are *smaller* than the specified value. This parameters supersedes the `newest_time` parameter (if both
	// are provided in the request).
	NewestRef *string
	// Filters the results by the creation time of resources and returns only transactions that are created *before*
	// the specified timestamp (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
	NewestTime *time.Time
	// Filters the results by the reference ID of transaction events and returns only transactions with events whose
	// IDs are *greater* than the specified value. This parameters supersedes the `oldest_time` parameter (if both
	// are provided in the request).
	OldestRef *string
	// Filters the results by the creation time of resources and returns only transactions that are created *at
	// or after* the specified timestamp (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
	OldestTime *time.Time
	// Specifies the order in which the returned results are displayed.
	Order *string
	// Filters the returned results by the specified list of payment types used for the transactions.
	PaymentTypes []shared.PaymentType
	// Filters the returned results by the specified list of final statuses of the transactions.
	Statuses []string
	// Retrieves the transaction resource with the specified transaction code.
	TransactionCode *string
	// Filters the returned results by the specified list of transaction types.
	Types []string
	// Filters the returned results by user email.
	Users []string
}

type ListTransactions200Response struct {
	Items []TransactionHistory `json:"items,omitempty"`
	Links []Link               `json:"links,omitempty"`
}

type ListTransactionsV21200Response struct {
	Items []TransactionHistory `json:"items,omitempty"`
	Links []Link               `json:"links,omitempty"`
}

type Lon float32

type PaymentType = shared.PaymentType

type Product struct {
	// Name of the product from the merchant's catalog.
	Name *string `json:"name,omitempty"`
	// Price of the product without VAT.
	Price *float32 `json:"price,omitempty"`
	// Price of a single product item with VAT.
	PriceWithVAT *float32 `json:"price_with_vat,omitempty"`
	// Number of product items for the purchase.
	Quantity *float64 `json:"quantity,omitempty"`
	// Amount of the VAT for a single product item (calculated as the product of `price` and `vat_rate`, i.e. `single_vat_amount
	// = price * vat_rate`).
	SingleVATAmount *float32 `json:"single_vat_amount,omitempty"`
	// Total price of the product items without VAT (calculated as the product of `price` and `quantity`, i.e. `total_price
	// = price * quantity`).
	TotalPrice *float32 `json:"total_price,omitempty"`
	// Total price of the product items including VAT (calculated as the product of `price_with_vat` and `quantity`, i.e.
	// `total_with_vat = price_with_vat * quantity`).
	TotalWithVAT *float32 `json:"total_with_vat,omitempty"`
	// Total VAT amount for the purchase (calculated as the product of `single_vat_amount` and `quantity`, i.e. `vat_amount
	// = single_vat_amount * quantity`).
	VATAmount *float32 `json:"vat_amount,omitempty"`
	// VAT rate applicable to the product.
	VATRate *float32 `json:"vat_rate,omitempty"`
}

type Refund struct {
	// Amount to be refunded. Eligible amount can't exceed the amount of the transaction and varies based on country
	// and currency. If you do not specify a value, the system performs a full refund of the transaction.
	Amount *float32 `json:"amount,omitempty"`
}

type TimestampEvent = shared.TimestampEvent

type TransactionEvent struct {
	// Amount of the event.
	Amount *shared.AmountEvent `json:"amount,omitempty"`
	// Date when the transaction event occurred.
	// Format: date
	Date *datetime.Date `json:"date,omitempty"`
	// Date when the transaction event is due to occur.
	// Format: date
	DueDate *datetime.Date `json:"due_date,omitempty"`
	// Type of the transaction event.
	EventType *shared.EventType `json:"event_type,omitempty"`
	// Unique ID of the transaction event.
	// Format: int64
	ID *shared.EventID `json:"id,omitempty"`
	// Consecutive number of the installment that is paid. Applicable only payout events, i.e. `event_type = PAYOUT`.
	InstallmentNumber *int `json:"installment_number,omitempty"`
	// Status of the transaction event.
	Status *shared.EventStatus `json:"status,omitempty"`
	// Date and time of the transaction event.
	Timestamp *shared.TimestampEvent `json:"timestamp,omitempty"`
}

type TransactionFull struct {
	// Total amount of the transaction.
	Amount *float32 `json:"amount,omitempty"`
	// Authorization code for the transaction sent by the payment card issuer or bank. Applicable only to card payments.
	AuthCode *string `json:"auth_code,omitempty"`
	// Details of the payment card.
	Card *CardResponse `json:"card,omitempty"`
	// Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported
	// currency values are enumerated above.
	Currency *shared.Currency `json:"currency,omitempty"`
	// Entry mode of the payment details.
	EntryMode *shared.EntryMode `json:"entry_mode,omitempty"`
	// List of events related to the transaction.
	// Unique items only
	Events []Event `json:"events,omitempty"`
	// Indication of the precision of the geographical position received from the payment terminal.
	HorizontalAccuracy *HorizontalAccuracy `json:"horizontal_accuracy,omitempty"`
	// Unique ID of the transaction.
	ID *string `json:"id,omitempty"`
	// Current number of the installment for deferred payments.
	// Min: 1
	InstallmentsCount *int `json:"installments_count,omitempty"`
	// Internal unique ID of the transaction on the SumUp platform.
	// Format: int64
	InternalID *int64 `json:"internal_id,omitempty"`
	// Latitude value from the coordinates of the payment location (as received from the payment terminal reader).
	// Min: 0
	// Max: 90
	Lat *Lat `json:"lat,omitempty"`
	// List of hyperlinks for accessing related resources.
	// Unique items only
	Links []any `json:"links,omitempty"`
	// Local date and time of the creation of the transaction.
	LocalTime *time.Time `json:"local_time,omitempty"`
	// Details of the payment location as received from the payment terminal.
	Location *TransactionFullLocation `json:"location,omitempty"`
	// Longitude value from the coordinates of the payment location (as received from the payment terminal reader).
	// Min: 0
	// Max: 180
	Lon *Lon `json:"lon,omitempty"`
	// Unique code of the registered merchant to whom the payment is made.
	MerchantCode *string `json:"merchant_code,omitempty"`
	// Payment type used for the transaction.
	PaymentType *shared.PaymentType `json:"payment_type,omitempty"`
	// Payout plan of the registered user at the time when the transaction was made.
	PayoutPlan *TransactionFullPayoutPlan `json:"payout_plan,omitempty"`
	// Payout type for the transaction.
	PayoutType *TransactionFullPayoutType `json:"payout_type,omitempty"`
	// Number of payouts that are made to the registered user specified in the `user` property.
	PayoutsReceived *int `json:"payouts_received,omitempty"`
	// Total number of payouts to the registered user specified in the `user` property.
	PayoutsTotal *int `json:"payouts_total,omitempty"`
	// Short description of the payment. The value is taken from the `description` property of the related checkout resource.
	ProductSummary *string `json:"product_summary,omitempty"`
	// List of products from the merchant's catalogue for which the transaction serves as a payment.
	Products []Product `json:"products,omitempty"`
	// Simple name of the payment type.
	SimplePaymentType *TransactionFullSimplePaymentType `json:"simple_payment_type,omitempty"`
	// Status generated from the processing status and the latest transaction state.
	SimpleStatus *TransactionFullSimpleStatus `json:"simple_status,omitempty"`
	// Current status of the transaction.
	Status *TransactionFullStatus `json:"status,omitempty"`
	// Indicates whether tax deduction is enabled for the transaction.
	TaxEnabled *bool `json:"tax_enabled,omitempty"`
	// Date and time of the creation of the transaction. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// Amount of the tip (out of the total transaction amount).
	TipAmount *float32 `json:"tip_amount,omitempty"`
	// Transaction code returned by the acquirer/processing entity after processing the transaction.
	TransactionCode *string `json:"transaction_code,omitempty"`
	// List of transaction events related to the transaction.
	TransactionEvents []TransactionEvent `json:"transaction_events,omitempty"`
	// Email address of the registered user (merchant) to whom the payment is made.
	// Format: email
	Username *string `json:"username,omitempty"`
	// Amount of the applicable VAT (out of the total transaction amount).
	VATAmount *float32 `json:"vat_amount,omitempty"`
	// List of VAT rates applicable to the transaction.
	VATRates []any `json:"vat_rates,omitempty"`
	// Verification method used for the transaction.
	VerificationMethod *TransactionFullVerificationMethod `json:"verification_method,omitempty"`
}

type TransactionFullLocation struct {
	// Indication of the precision of the geographical position received from the payment terminal.
	HorizontalAccuracy *HorizontalAccuracy `json:"horizontal_accuracy,omitempty"`
	// Latitude value from the coordinates of the payment location (as received from the payment terminal reader).
	// Min: 0
	// Max: 90
	Lat *Lat `json:"lat,omitempty"`
	// Longitude value from the coordinates of the payment location (as received from the payment terminal reader).
	// Min: 0
	// Max: 180
	Lon *Lon `json:"lon,omitempty"`
}

type TransactionFullPayoutPlan string

type TransactionFullPayoutType string

type TransactionFullSimplePaymentType string

type TransactionFullSimpleStatus string

type TransactionFullStatus string

type TransactionFullVerificationMethod string

type TransactionHistory struct {
	// Total amount of the transaction.
	Amount *float32 `json:"amount,omitempty"`
	// Issuing card network of the payment card used for the transaction.
	CardType *shared.CardType `json:"card_type,omitempty"`
	// Client-specific ID of the transaction.
	ClientTransactionID *string `json:"client_transaction_id,omitempty"`
	// Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported
	// currency values are enumerated above.
	Currency *shared.Currency `json:"currency,omitempty"`
	// Unique ID of the transaction.
	ID *string `json:"id,omitempty"`
	// Current number of the installment for deferred payments.
	// Min: 1
	InstallmentsCount *int `json:"installments_count,omitempty"`
	// Payment type used for the transaction.
	PaymentType *shared.PaymentType `json:"payment_type,omitempty"`
	// Payout plan of the registered user at the time when the transaction was made.
	PayoutPlan *TransactionHistoryPayoutPlan `json:"payout_plan,omitempty"`
	// Number of payouts that are made to the registered user specified in the `user` property.
	PayoutsReceived *int `json:"payouts_received,omitempty"`
	// Total number of payouts to the registered user specified in the `user` property.
	PayoutsTotal *int `json:"payouts_total,omitempty"`
	// Short description of the payment. The value is taken from the `description` property of the related checkout resource.
	ProductSummary *string `json:"product_summary,omitempty"`
	// Current status of the transaction.
	Status *TransactionHistoryStatus `json:"status,omitempty"`
	// Date and time of the creation of the transaction. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// Transaction code returned by the acquirer/processing entity after processing the transaction.
	TransactionCode *string `json:"transaction_code,omitempty"`
	// Unique ID of the transaction.
	TransactionID *shared.TransactionID `json:"transaction_id,omitempty"`
	// Type of the transaction for the registered user specified in the `user` property.
	Type *TransactionHistoryType `json:"type,omitempty"`
	// Email address of the registered user (merchant) to whom the payment is made.
	// Format: email
	User *string `json:"user,omitempty"`
}

type TransactionHistoryPayoutPlan string

type TransactionHistoryStatus string

type TransactionHistoryType string

type TransactionID = shared.TransactionID

type TransactionMixinHistory struct {
	// Payout plan of the registered user at the time when the transaction was made.
	PayoutPlan *TransactionMixinHistoryPayoutPlan `json:"payout_plan,omitempty"`
	// Number of payouts that are made to the registered user specified in the `user` property.
	PayoutsReceived *int `json:"payouts_received,omitempty"`
	// Total number of payouts to the registered user specified in the `user` property.
	PayoutsTotal *int `json:"payouts_total,omitempty"`
	// Short description of the payment. The value is taken from the `description` property of the related checkout resource.
	ProductSummary *string `json:"product_summary,omitempty"`
}

type TransactionMixinHistoryPayoutPlan string