sumup

type APIError struct {
	StatusCode int
	Headers    http.Header
	Body       []byte
	Err        error
}

type Address struct {
	// In Spain, an autonomous community is the first sub-national level of political and administrative division.
	// Max length: 60
	AutonomousCommunity *string `json:"autonomous_community,omitempty"`
	// The city of the address.
	// Max length: 60
	City *string `json:"city,omitempty"`
	// In many countries, terms cognate with "commune" are used, referring to the community living in the area and
	// the common interest. Used in countries such as Chile.
	// Max length: 60
	Commune *string `json:"commune,omitempty"`
	// The ISO3166-1 Alpha-2 code of the address country.
	// Min length: 2
	// Max length: 2
	// Pattern: ^[A-Z]{2}$
	Country CountryCode `json:"country"`
	// A county is a geographic region of a country used for administrative or other purposes in some nations. Used
	// in countries such as Ireland, Romania, etc.
	// Max length: 60
	County *string `json:"county,omitempty"`
	// A department (French: département, Spanish: departamento) is an administrative or political division in
	// several countries. Used in countries such as Colombia.
	// Max length: 60
	Department *string `json:"department,omitempty"`
	// A district is a type of administrative division that in some countries is managed by the local government. Used
	// in countries such as Portugal.
	// Max length: 60
	District *string `json:"district,omitempty"`
	// A postal address in Ireland.
	// Max length: 10
	Eircode *string `json:"eircode,omitempty"`
	// A municipality is usually a single administrative division having corporate status and powers of self-government or
	// jurisdiction as granted by national and regional laws to which it is subordinate. Used in countries such as
	// Colombia.
	// Max length: 60
	Municipality *string `json:"municipality,omitempty"`
	// Locality level of the address. Used in countries such as Brazil or Chile.
	// Max length: 60
	Neighborhood *string `json:"neighborhood,omitempty"`
	// The postal code (aka. zip code) of the address.
	// Max length: 10
	PostCode *string `json:"post_code,omitempty"`
	// A post town is a required part of all postal addresses in the United Kingdom and Ireland, and a basic unit
	// of the postal delivery system.
	// Max length: 60
	PostTown *string `json:"post_town,omitempty"`
	// The province where the address is located. This may not be relevant in some countries.
	// Max length: 60
	Province *string `json:"province,omitempty"`
	// The region where the address is located. This may not be relevant in some countries.
	// Max length: 60
	Region *string `json:"region,omitempty"`
	// Most often, a country has a single state, with various administrative divisions. The term "state" is sometimes
	// used to refer to the federated polities that make up the federation. Used in countries such as the United States
	// and Brazil.
	// Max length: 60
	State *string `json:"state,omitempty"`
	// Max items: 2
	StreetAddress []string `json:"street_address,omitempty"`
	// A US system of postal codes used by the United States Postal Service (USPS).
	// Max length: 10
	ZipCode *string `json:"zip_code,omitempty"`
}

type AddressLegacy struct {
	// City name from the address.
	City *string `json:"city,omitempty"`
	// Two letter country code formatted according to [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
	Country *string `json:"country,omitempty"`
	// First line of the address with details of the street name and number.
	Line1 *string `json:"line_1,omitempty"`
	// Second line of the address with details of the building, unit, apartment, and floor numbers.
	Line2 *string `json:"line_2,omitempty"`
	// Postal code from the address.
	PostalCode *string `json:"postal_code,omitempty"`
	// State name or abbreviation from the address.
	State *string `json:"state,omitempty"`
}

type Affiliate struct {
	AppID string `json:"app_id"`
	Key   string `json:"key"`
}

type Amount struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// Amount in minor units (e.g. cents).
	Value int `json:"value"`
}

type Attributes map[string]any

type BadRequest struct {
	Errors BadRequestErrors `json:"errors"`
}

type BadRequestErrors struct {
	// Fuller message giving context to error
	Detail *string `json:"detail,omitempty"`
	// Key indicating type of error
	Type BadRequestErrorsType `json:"type"`
}

type BadRequestErrorsType string

type BasePerson struct {
	// An address somewhere in the world. The address fields used depend on the country conventions. For example, in
	// Great Britain, `city` is `post_town`. In the United States, the top-level administrative unit used in addresses
	// is `state`, whereas in Chile it's `region`.
	// Whether an address is valid or not depends on whether the locally required fields are present. Fields not
	// supported in a country will be ignored.
	// Address documentation: https://developer.sumup.com/tools/glossary/address
	Address *Address `json:"address,omitempty"`
	// The date of birth of the individual, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format.
	// Format: date
	Birthdate *datetime.Date `json:"birthdate,omitempty"`
	// Reflects the status of changes submitted through the `PATCH` endpoints for the Merchant or Persons. If some
	// changes have not been applied yet, the status will be `pending`. If all changes have been applied, the status
	// `done`.
	// The status is only returned after write operations or on read endpoints when the `version` query parameter is
	// provided.
	// Read only
	ChangeStatus *ChangeStatus `json:"change_status,omitempty"`
	// An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
	// country code. This definition users `oneOf` with a two-character string
	// type to allow for support of future countries in client code.
	// Min length: 2
	// Max length: 2
	// Pattern: ^[A-Z]{2}$
	Citizenship *CountryCode `json:"citizenship,omitempty"`
	// An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code representing the country
	// where the Person resides.
	// Pattern: ^[A-Z]{2}$
	CountryOfResidence *nullable.Field[string] `json:"country_of_residence,omitempty"`
	// The last name(s) of the individual.
	// Min length: 1
	// Max length: 60
	FamilyName *string `json:"family_name,omitempty"`
	// The first name(s) of the individual.
	// Min length: 1
	// Max length: 60
	GivenName *string `json:"given_name,omitempty"`
	// The unique identifier for the Person. This is a [typeid](https://github.com/sumup/typeid).
	// Read only
	ID string `json:"id"`
	// A list of country-specific personal identifiers.
	// Max items: 32
	Identifiers PersonalIdentifiers `json:"identifiers,omitempty"`
	// The Person's nationality. May be an [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country
	// code, but legacy data may not conform to this standard.
	// Pattern: ^[A-Z]{2}$
	Nationality *nullable.Field[string] `json:"nationality,omitempty"`
	Ownership   *Ownership              `json:"ownership,omitempty"`
	// A publicly available phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
	// Max length: 16
	PhoneNumber *PhoneNumber `json:"phone_number,omitempty"`
	// A list of roles the Person has in the Merchant or towards SumUp. A Merchant must have at least one Person with
	// the relationship `representative`.
	// Min items: 1
	// Max items: 1
	Relationships []string `json:"relationships,omitempty"`
	// A corresponding identity user ID for the Person, if they have a user account.
	UserID *string `json:"user_id,omitempty"`
	// The version of the resource. The version reflects a specific change submitted to the API via one of the `PATCH`
	// endpoints.
	Version *Version `json:"version,omitempty"`
}

type Brand string

type Branding struct {
	// A hex color value representing the preferred background color of this merchant.
	BackgroundColor *string `json:"background_color,omitempty"`
	// Footer text rendered on receipts and other customer-facing products.
	// Min length: 1
	// Max length: 500
	FooterText *string `json:"footer_text,omitempty"`
	// Data-URL encoded hero image for the merchant business.
	// Format: uri
	Hero *string `json:"hero,omitempty"`
	// An icon for the merchant. Must be square.
	// Format: uri
	Icon *string `json:"icon,omitempty"`
	// A logo for the merchant that will be used in place of the icon and without the merchant's name next to it
	// if there's sufficient space.
	// Format: uri
	Logo *string `json:"logo,omitempty"`
	// A hex color value representing the primary branding color of this merchant (your brand color).
	PrimaryColor *string `json:"primary_color,omitempty"`
	// A hex color value representing the color of the text displayed on branding color of this merchant.
	PrimaryColorFg *string `json:"primary_color_fg,omitempty"`
	// A hex color value representing the secondary branding color of this merchant (accent color used for buttons).
	SecondaryColor *string `json:"secondary_color,omitempty"`
	// A hex color value representing the color of the text displayed on secondary branding color of this merchant.
	SecondaryColorFg *string `json:"secondary_color_fg,omitempty"`
}

type BusinessProfile struct {
	// An address somewhere in the world. The address fields used depend on the country conventions. For example, in
	// Great Britain, `city` is `post_town`. In the United States, the top-level administrative unit used in addresses
	// is `state`, whereas in Chile it's `region`.
	// Whether an address is valid or not depends on whether the locally required fields are present. Fields not
	// supported in a country will be ignored.
	// Address documentation: https://developer.sumup.com/tools/glossary/address
	Address *Address `json:"address,omitempty"`
	// Settings used to apply the Merchant's branding to email receipts, invoices, checkouts, and other products.
	Branding *Branding `json:"branding,omitempty"`
	// The descriptor is the text that your customer sees on their bank account statement.
	// The more recognisable your descriptor is, the less risk you have of receiving disputes (e.g. chargebacks).
	// Min length: 1
	// Max length: 30
	// Pattern: ^[a-zA-Z0-9 +'_.-]+$
	DynamicDescriptor *string `json:"dynamic_descriptor,omitempty"`
	// A publicly available email address.
	// Min length: 1
	// Max length: 255
	Email *string `json:"email,omitempty"`
	// The customer-facing business name.
	// Min length: 1
	// Max length: 150
	Name *string `json:"name,omitempty"`
	// A publicly available phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
	// Max length: 16
	PhoneNumber *PhoneNumber `json:"phone_number,omitempty"`
	// The business's publicly available website.
	// Min length: 1
	// Max length: 255
	Website *string `json:"website,omitempty"`
}

type Card struct {
	// Three or four-digit card verification value (security code) of the payment card.
	// Write only
	// Min length: 3
	// Max length: 4
	Cvv string `json:"cvv"`
	// Two-digit expiration month, from `01` through `12`.
	// Write only
	// Min length: 2
	// Max length: 2
	// Pattern: ^(0[1-9]|1[0-2])$
	ExpiryMonth string `json:"expiry_month"`
	// Two- or four-digit expiration year in `YY` or `YYYY` format.
	// Write only
	// Pattern: ^[0-9]{2}([0-9]{2})?$
	ExpiryYear string `json:"expiry_year"`
	// Name of the cardholder as it appears on the payment card.
	// Write only
	Name string `json:"name"`
	// Number of the payment card (without spaces).
	// Write only
	Number string `json:"number"`
	// Issuing card network of the payment card used for the transaction.
	Type CardType `json:"type"`
	// Required five-digit ZIP code. Applicable only to merchant users in the USA.
	// Write only
	// Min length: 5
	// Max length: 5
	ZipCode *string `json:"zip_code,omitempty"`
}

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"`
	// Payment Account Reference (PAR) defined by [EMVCo](https://www.emvco.com/emv-technologies/payment-tokenisation/). It
	// links a card's primary account number (PAN) with its affiliated payment tokens, allowing transactions made
	// with the physical card and tokenized versions of that card, such as digital wallets, to be correlated when
	// PAR is available.
	//
	// This reference cannot be used to initiate a payment and is separate from the saved payment instrument `token`
	// used to process checkouts. Returned only when available for the card; integrations must handle its absence.
	PaymentAccountReference *string `json:"payment_account_reference,omitempty"`
	// Issuing card network of the payment card used for the transaction.
	Type *CardType `json:"type,omitempty"`
}

type CardType string

type CategoryV10 struct {
	// The category id. Usually a UUID, but not always (legacy cases).
	// Max length: 100
	ID string `json:"id"`
	// The category name.
	// Max length: 30
	Name string `json:"name"`
}

type ChangeStatus string

type Checkout struct {
	// Amount to be charged to the payer, expressed in major units.
	Amount *float32 `json:"amount,omitempty"`
	// Merchant-defined reference for the checkout. Use it to correlate the SumUp checkout with your own order, cart,
	// subscription, or payment attempt in your systems.
	// Max length: 64
	CheckoutReference *string `json:"checkout_reference,omitempty"`
	// Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
	Currency *Currency `json:"currency,omitempty"`
	// Merchant-scoped identifier of the customer associated with the checkout. Use it when storing payment instruments
	// or reusing saved customer context for recurring and returning-payer flows.
	CustomerID *string `json:"customer_id,omitempty"`
	// The timestamp of when the checkout was created.
	Date *time.Time `json:"date,omitempty"`
	// Short merchant-defined description shown in SumUp tools and reporting. Use it to make the checkout easier to
	// recognize in dashboards, support workflows, and reconciliation.
	Description *string `json:"description,omitempty"`
	// URL of the SumUp-hosted payment page that handles the payment flow. Returned when Hosted Checkout is enabled
	// for the checkout.
	// Read only
	// Format: uri
	HostedCheckoutURL *string `json:"hosted_checkout_url,omitempty"`
	// Unique SumUp identifier of the checkout resource.
	// Read only
	ID *string `json:"id,omitempty"`
	// Details of the mandate linked to the saved payment instrument.
	Mandate *MandateResponse `json:"mandate,omitempty"`
	// Short unique identifier for the merchant that receives the payment.
	MerchantCode *string `json:"merchant_code,omitempty"`
	// Optional backend callback URL for checkout status notifications. SumUp sends an HTTP POST with `event_type` and
	// the checkout `id`. Retrieve the checkout to verify its current status before updating your order. See the
	// [webhook guide](https://developer.sumup.com/online-payments/webhooks/) for the payload and response requirements.
	// Format: uri
	ReturnURL *string `json:"return_url,omitempty"`
	// Current high-level state of the checkout. `PENDING` means the checkout exists but is not yet completed, `PAID`
	// means a payment succeeded, `FAILED` means the latest processing attempt failed, and `EXPIRED` means the checkout
	// can no longer be processed.
	Status *CheckoutStatus `json:"status,omitempty"`
	// Payment attempts and resulting transaction records linked to this checkout. Use the Transactions endpoints when
	// you need the authoritative payment result and event history.
	// Unique items only
	Transactions []CheckoutTransaction `json:"transactions,omitempty"`
	// Optional expiration timestamp. The checkout must be processed before this moment, otherwise it becomes unusable.
	// If omitted, the checkout does not have an explicit expiry time.
	ValidUntil *nullable.Field[time.Time] `json:"valid_until,omitempty"`
}

type CheckoutAccepted struct {
	// Instructions for the next action the payer or client must take.
	NextStep *CheckoutAcceptedNextStep `json:"next_step,omitempty"`
}

type CheckoutAcceptedNextStep struct {
	// Allowed presentation mechanisms for the next step. `iframe` means the flow can be embedded, while `browser` means
	// it can be completed through a full-page redirect.
	Mechanism []CheckoutAcceptedNextStepMechanism `json:"mechanism,omitempty"`
	// HTTP method to use when following the next step.
	Method *string `json:"method,omitempty"`
	// Parameters required to complete the next step. The exact keys depend on the payment provider and flow type.
	Payload CheckoutAcceptedNextStepPayload `json:"payload,omitempty"`
	// Merchant URL where the payer returns after the external flow finishes.
	RedirectURL *string `json:"redirect_url,omitempty"`
	// URL to open or submit in order to continue processing.
	URL *string `json:"url,omitempty"`
}

type CheckoutAcceptedNextStepMechanism string

type CheckoutAcceptedNextStepPayload map[string]any

type CheckoutCreateRequest struct {
	// Amount to be charged to the payer, expressed in major units.
	Amount float32 `json:"amount"`
	// Merchant-defined reference for the new checkout, up to 64 characters. Use it to correlate the checkout with
	// an order or payment attempt in your own system. If a checkout already exists for the supplied unique parameters,
	// creation returns `409` with `DUPLICATED_CHECKOUT`; see the conflict response.
	// Max length: 64
	CheckoutReference string `json:"checkout_reference"`
	// Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
	Currency Currency `json:"currency"`
	// Merchant-scoped customer identifier. Required when setting up recurring payments and useful when the checkout
	// should be linked to a returning payer.
	CustomerID *string `json:"customer_id,omitempty"`
	// Short merchant-defined description shown in SumUp tools and reporting for easier identification of the checkout.
	Description *string `json:"description,omitempty"`
	// Hosted Checkout configuration. Enable it to receive a SumUp-hosted payment page URL in the checkout response.
	HostedCheckout *HostedCheckout `json:"hosted_checkout,omitempty"`
	// Short unique identifier for the merchant that should receive the payment.
	MerchantCode string `json:"merchant_code"`
	// Business purpose of the checkout. Use `CHECKOUT` for a standard payment and `SETUP_RECURRING_PAYMENT` when
	// collecting consent and payment details for future recurring charges.
	// Default: CHECKOUT
	Purpose *CheckoutCreateRequestPurpose `json:"purpose,omitempty"`
	// URL where the payer should be sent after a redirect-based payment or SCA flow completes. This is required for
	// [APMs](https://developer.sumup.com/online-payments/apm/introduction) and recommended for card checkouts that
	// may require [3DS](https://developer.sumup.com/online-payments/features/3ds). If it is omitted, the [Payment Widget](https://developer.sumup.com/online-payments/checkouts)
	// can render the challenge in an iframe instead of using a full-page redirect.
	RedirectURL *string `json:"redirect_url,omitempty"`
	// Optional backend callback URL for checkout status notifications. SumUp sends an HTTP POST with `event_type` and
	// the checkout `id`. Retrieve the checkout to verify its current status before updating your order. See the
	// [webhook guide](https://developer.sumup.com/online-payments/webhooks/) for the payload and response requirements.
	// Format: uri
	ReturnURL *string `json:"return_url,omitempty"`
	// Optional expiration timestamp. The checkout must be processed before this moment, otherwise it becomes unusable.
	// If omitted, the checkout does not have an explicit expiry time.
	ValidUntil *nullable.Field[time.Time] `json:"valid_until,omitempty"`
}

type CheckoutCreateRequestPurpose string

type CheckoutCreatedEvent struct{ TypedEvent[Checkout] }

type CheckoutExpiredEvent struct{ TypedEvent[Checkout] }

type CheckoutFailedEvent struct{ TypedEvent[Checkout] }

type CheckoutPaidEvent struct{ TypedEvent[Checkout] }

type CheckoutStatus string

type CheckoutSuccess struct {
	// Amount to be charged to the payer, expressed in major units.
	Amount *float32 `json:"amount,omitempty"`
	// Merchant-defined reference for the checkout. Use it to correlate the SumUp checkout with your own order, cart,
	// subscription, or payment attempt in your systems.
	// Max length: 64
	CheckoutReference *string `json:"checkout_reference,omitempty"`
	// Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
	Currency *Currency `json:"currency,omitempty"`
	// Merchant-scoped identifier of the customer associated with the checkout. Use it when storing payment instruments
	// or reusing saved customer context for recurring and returning-payer flows.
	CustomerID *string `json:"customer_id,omitempty"`
	// The timestamp of when the checkout was created.
	Date *time.Time `json:"date,omitempty"`
	// Short merchant-defined description shown in SumUp tools and reporting. Use it to make the checkout easier to
	// recognize in dashboards, support workflows, and reconciliation.
	Description *string `json:"description,omitempty"`
	// URL of the SumUp-hosted payment page that handles the payment flow. Returned when Hosted Checkout is enabled
	// for the checkout.
	// Read only
	// Format: uri
	HostedCheckoutURL *string `json:"hosted_checkout_url,omitempty"`
	// Unique SumUp identifier of the checkout resource.
	// Read only
	ID *string `json:"id,omitempty"`
	// Details of the mandate linked to the saved payment instrument.
	Mandate *MandateResponse `json:"mandate,omitempty"`
	// Short unique identifier for the merchant that receives the payment.
	MerchantCode *string `json:"merchant_code,omitempty"`
	// Name of the merchant.
	MerchantName *string `json:"merchant_name,omitempty"`
	// Details of the saved payment instrument created or reused during checkout processing.
	PaymentInstrument *CheckoutSuccessPaymentInstrument `json:"payment_instrument,omitempty"`
	// URL where the payer is redirected after a redirect-based payment or SCA flow completes.
	RedirectURL *string `json:"redirect_url,omitempty"`
	// Optional backend callback URL for checkout status notifications. SumUp sends an HTTP POST with `event_type` and
	// the checkout `id`. Retrieve the checkout to verify its current status before updating your order. See the
	// [webhook guide](https://developer.sumup.com/online-payments/webhooks/) for the payload and response requirements.
	// Format: uri
	ReturnURL *string `json:"return_url,omitempty"`
	// Current high-level state of the checkout. `PENDING` means the checkout exists but is not yet completed, `PAID`
	// means a payment succeeded, `FAILED` means the latest processing attempt failed, and `EXPIRED` means the checkout
	// can no longer be processed.
	Status *CheckoutSuccessStatus `json:"status,omitempty"`
	// Transaction code of the successful transaction with which the payment for the checkout is completed.
	// Read only
	TransactionCode *string `json:"transaction_code,omitempty"`
	// Unique identifier of the successful transaction that completed payment for the checkout.
	// Read only
	TransactionID *string `json:"transaction_id,omitempty"`
	// Payment attempts and resulting transaction records linked to this checkout. Use the Transactions endpoints when
	// you need the authoritative payment result and event history.
	// Unique items only
	Transactions []CheckoutSuccessTransaction `json:"transactions,omitempty"`
	// Optional expiration timestamp. The checkout must be processed before this moment, otherwise it becomes unusable.
	// If omitted, the checkout does not have an explicit expiry time.
	ValidUntil *nullable.Field[time.Time] `json:"valid_until,omitempty"`
}

type CheckoutSuccessPaymentInstrument struct {
	// Unique token of the saved payment instrument.
	Token *string `json:"token,omitempty"`
}

type CheckoutSuccessStatus string

type CheckoutSuccessTransaction struct {
	// Total amount of the transaction in major units of `currency`, for example `10.1` for EUR 10.10.
	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"`
	// Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
	Currency *Currency `json:"currency,omitempty"`
	// How the payment details were captured, for example `CHIP` or `CONTACTLESS` for card-present payments and
	// `CUSTOMER_ENTRY` for card details entered by the payer. For wallet and alternative payment methods, this can
	// identify the method, such as `APPLE_PAY` or `BLIK`.
	EntryMode *EntryMode `json:"entry_mode,omitempty"`
	// Unique identifier of the transaction.
	ID *string `json:"id,omitempty"`
	// Number of installments for a deferred payment.
	// Min: 1
	InstallmentsCount *int `json:"installments_count,omitempty"`
	// Unique code of the registered merchant to whom the payment is made.
	MerchantCode *string `json:"merchant_code,omitempty"`
	// Payment category recorded on a transaction, for example `POS` for a point-of-sale card payment, `ECOM` for
	// an online card payment, or `RECURRING` for a recurring card payment. These reporting values are separate from
	// the lowercase `payment_type` values used to process checkouts.
	PaymentType *PaymentType `json:"payment_type,omitempty"`
	// Current status of the transaction.
	//
	// - `PENDING`: The transaction has been created but its final outcome is not known yet.
	// - `SUCCESSFUL`: The transaction completed successfully.
	// - `CANCELLED`: The transaction was cancelled or otherwise reversed before completion.
	// - `FAILED`: The transaction attempt did not complete successfully.
	// - `REFUNDED`: The transaction was refunded in full or in part.
	Status *TransactionStatus `json:"status,omitempty"`
	// The timestamp of when the transaction was created.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// Tip included in the total transaction amount, in major units of the transaction's currency.
	TipAmount *float32 `json:"tip_amount,omitempty"`
	// SumUp transaction code, for example `TEENSK4W2K`. Use it to look up the transaction with the `transaction_code` query
	// parameter. This is separate from the transaction's `id` and the card issuer's `auth_code`.
	TransactionCode *string `json:"transaction_code,omitempty"`
	// VAT included in the total transaction amount, in major units of the transaction's currency.
	VATAmount *float32 `json:"vat_amount,omitempty"`
}

type CheckoutTransaction struct {
	// Total amount of the transaction in major units of `currency`, for example `10.1` for EUR 10.10.
	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"`
	// Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
	Currency *Currency `json:"currency,omitempty"`
	// How the payment details were captured, for example `CHIP` or `CONTACTLESS` for card-present payments and
	// `CUSTOMER_ENTRY` for card details entered by the payer. For wallet and alternative payment methods, this can
	// identify the method, such as `APPLE_PAY` or `BLIK`.
	EntryMode *EntryMode `json:"entry_mode,omitempty"`
	// Unique identifier of the transaction.
	ID *string `json:"id,omitempty"`
	// Number of installments for a deferred payment.
	// Min: 1
	InstallmentsCount *int `json:"installments_count,omitempty"`
	// Unique code of the registered merchant to whom the payment is made.
	MerchantCode *string `json:"merchant_code,omitempty"`
	// Payment category recorded on a transaction, for example `POS` for a point-of-sale card payment, `ECOM` for
	// an online card payment, or `RECURRING` for a recurring card payment. These reporting values are separate from
	// the lowercase `payment_type` values used to process checkouts.
	PaymentType *PaymentType `json:"payment_type,omitempty"`
	// Current status of the transaction.
	//
	// - `PENDING`: The transaction has been created but its final outcome is not known yet.
	// - `SUCCESSFUL`: The transaction completed successfully.
	// - `CANCELLED`: The transaction was cancelled or otherwise reversed before completion.
	// - `FAILED`: The transaction attempt did not complete successfully.
	// - `REFUNDED`: The transaction was refunded in full or in part.
	Status *TransactionStatus `json:"status,omitempty"`
	// The timestamp of when the transaction was created.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// Tip included in the total transaction amount, in major units of the transaction's currency.
	TipAmount *float32 `json:"tip_amount,omitempty"`
	// SumUp transaction code, for example `TEENSK4W2K`. Use it to look up the transaction with the `transaction_code` query
	// parameter. This is separate from the transaction's `id` and the card issuer's `auth_code`.
	TransactionCode *string `json:"transaction_code,omitempty"`
	// VAT included in the total transaction amount, in major units of the transaction's currency.
	VATAmount *float32 `json:"vat_amount,omitempty"`
}

type CheckoutUpdateRequest struct {
	// Updated amount to be charged to the payer, expressed in major units.
	Amount *float32 `json:"amount,omitempty"`
	// Updated merchant-defined reference for the checkout.
	// Max length: 64
	CheckoutReference *string `json:"checkout_reference,omitempty"`
	// Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
	Currency *Currency `json:"currency,omitempty"`
	// Updated merchant-scoped customer identifier associated with the checkout.
	CustomerID *string `json:"customer_id,omitempty"`
	// Updated short merchant-defined description shown in SumUp tools and reporting.
	Description *string `json:"description,omitempty"`
	// Updated expiration timestamp. The checkout must be processed before this moment, otherwise it becomes unusable.
	ValidUntil *nullable.Field[time.Time] `json:"valid_until,omitempty"`
}

type CheckoutUpdatedEvent struct{ TypedEvent[Checkout] }

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

type CheckoutsCreateApplePaySession400Response json.RawMessage

type CheckoutsCreateApplePaySessionParams struct {
	// Hostname of the website displaying the Apple Pay payment sheet, without a URL scheme or path. Use the domain
	// registered for Apple Pay.
	// Format: hostname
	Context string `json:"context"`
	// Apple Pay validation URL received as `validationURL` in the browser's `onvalidatemerchant` event.
	// Format: uri
	Target string `json:"target"`
}

type CheckoutsCreateApplePaySessionResponse = json.RawMessage

type CheckoutsCreateParams = CheckoutCreateRequest

type CheckoutsListAvailablePaymentMethodsParams struct {
	// Payment amount in major units, for example `9.99` for EUR 9.99. When filtering by `amount`, also provide `currency`.
	Amount *float64
	// Three-letter ISO 4217 currency code for which the payment methods should be eligible, for example `EUR`.
	Currency *string
}

type CheckoutsListAvailablePaymentMethodsResponse struct {
	// Payment methods available to the merchant for the checkout.
	AvailablePaymentMethods []CheckoutsListAvailablePaymentMethodsResponseAvailablePaymentMethod `json:"available_payment_methods,omitempty"`
}

type CheckoutsListAvailablePaymentMethodsResponseAvailablePaymentMethod struct {
	// Unique identifier of the payment method.
	ID string `json:"id"`
}

type CheckoutsListParams struct {
	// Filters checkouts by the merchant-defined `checkout_reference` supplied when creating the checkout. This is
	// separate from the SumUp-generated checkout `id`.
	CheckoutReference *string
}

type CheckoutsListResponse []CheckoutSuccess

type CheckoutsProcess400Response json.RawMessage

type CheckoutsProcessCheckoutSuccessResponse struct {
	// Amount to be charged to the payer, expressed in major units.
	Amount *float32 `json:"amount,omitempty"`
	// Merchant-defined reference for the checkout. Use it to correlate the SumUp checkout with your own order, cart,
	// subscription, or payment attempt in your systems.
	// Max length: 64
	CheckoutReference *string `json:"checkout_reference,omitempty"`
	// Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
	Currency *Currency `json:"currency,omitempty"`
	// Merchant-scoped identifier of the customer associated with the checkout. Use it when storing payment instruments
	// or reusing saved customer context for recurring and returning-payer flows.
	CustomerID *string `json:"customer_id,omitempty"`
	// The timestamp of when the checkout was created.
	Date *time.Time `json:"date,omitempty"`
	// Short merchant-defined description shown in SumUp tools and reporting. Use it to make the checkout easier to
	// recognize in dashboards, support workflows, and reconciliation.
	Description *string `json:"description,omitempty"`
	// URL of the SumUp-hosted payment page that handles the payment flow. Returned when Hosted Checkout is enabled
	// for the checkout.
	// Read only
	// Format: uri
	HostedCheckoutURL *string `json:"hosted_checkout_url,omitempty"`
	// Unique SumUp identifier of the checkout resource.
	// Read only
	ID *string `json:"id,omitempty"`
	// Details of the mandate linked to the saved payment instrument.
	Mandate *MandateResponse `json:"mandate,omitempty"`
	// Short unique identifier for the merchant that receives the payment.
	MerchantCode *string `json:"merchant_code,omitempty"`
	// Name of the merchant.
	MerchantName *string `json:"merchant_name,omitempty"`
	// Details of the saved payment instrument created or reused during checkout processing.
	PaymentInstrument *CheckoutsProcessCheckoutSuccessResponsePaymentInstrument `json:"payment_instrument,omitempty"`
	// URL where the payer is redirected after a redirect-based payment or SCA flow completes.
	RedirectURL *string `json:"redirect_url,omitempty"`
	// Optional backend callback URL for checkout status notifications. SumUp sends an HTTP POST with `event_type` and
	// the checkout `id`. Retrieve the checkout to verify its current status before updating your order. See the
	// [webhook guide](https://developer.sumup.com/online-payments/webhooks/) for the payload and response requirements.
	// Format: uri
	ReturnURL *string `json:"return_url,omitempty"`
	// Current high-level state of the checkout. `PENDING` means the checkout exists but is not yet completed, `PAID`
	// means a payment succeeded, `FAILED` means the latest processing attempt failed, and `EXPIRED` means the checkout
	// can no longer be processed.
	Status *CheckoutsProcessCheckoutSuccessResponseStatus `json:"status,omitempty"`
	// Transaction code of the successful transaction with which the payment for the checkout is completed.
	// Read only
	TransactionCode *string `json:"transaction_code,omitempty"`
	// Unique identifier of the successful transaction that completed payment for the checkout.
	// Read only
	TransactionID *string `json:"transaction_id,omitempty"`
	// Payment attempts and resulting transaction records linked to this checkout. Use the Transactions endpoints when
	// you need the authoritative payment result and event history.
	// Unique items only
	Transactions []CheckoutsProcessCheckoutSuccessResponseTransaction `json:"transactions,omitempty"`
	// Optional expiration timestamp. The checkout must be processed before this moment, otherwise it becomes unusable.
	// If omitted, the checkout does not have an explicit expiry time.
	ValidUntil *nullable.Field[time.Time] `json:"valid_until,omitempty"`
}

type CheckoutsProcessCheckoutSuccessResponsePaymentInstrument struct {
	// Unique token of the saved payment instrument.
	Token *string `json:"token,omitempty"`
}

type CheckoutsProcessCheckoutSuccessResponseStatus string

type CheckoutsProcessCheckoutSuccessResponseTransaction struct {
	// Total amount of the transaction in major units of `currency`, for example `10.1` for EUR 10.10.
	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"`
	// Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
	Currency *Currency `json:"currency,omitempty"`
	// How the payment details were captured, for example `CHIP` or `CONTACTLESS` for card-present payments and
	// `CUSTOMER_ENTRY` for card details entered by the payer. For wallet and alternative payment methods, this can
	// identify the method, such as `APPLE_PAY` or `BLIK`.
	EntryMode *EntryMode `json:"entry_mode,omitempty"`
	// Unique identifier of the transaction.
	ID *string `json:"id,omitempty"`
	// Number of installments for a deferred payment.
	// Min: 1
	InstallmentsCount *int `json:"installments_count,omitempty"`
	// Unique code of the registered merchant to whom the payment is made.
	MerchantCode *string `json:"merchant_code,omitempty"`
	// Payment category recorded on a transaction, for example `POS` for a point-of-sale card payment, `ECOM` for
	// an online card payment, or `RECURRING` for a recurring card payment. These reporting values are separate from
	// the lowercase `payment_type` values used to process checkouts.
	PaymentType *PaymentType `json:"payment_type,omitempty"`
	// Current status of the transaction.
	//
	// - `PENDING`: The transaction has been created but its final outcome is not known yet.
	// - `SUCCESSFUL`: The transaction completed successfully.
	// - `CANCELLED`: The transaction was cancelled or otherwise reversed before completion.
	// - `FAILED`: The transaction attempt did not complete successfully.
	// - `REFUNDED`: The transaction was refunded in full or in part.
	Status *TransactionStatus `json:"status,omitempty"`
	// The timestamp of when the transaction was created.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// Tip included in the total transaction amount, in major units of the transaction's currency.
	TipAmount *float32 `json:"tip_amount,omitempty"`
	// SumUp transaction code, for example `TEENSK4W2K`. Use it to look up the transaction with the `transaction_code` query
	// parameter. This is separate from the transaction's `id` and the card issuer's `auth_code`.
	TransactionCode *string `json:"transaction_code,omitempty"`
	// VAT included in the total transaction amount, in major units of the transaction's currency.
	VATAmount *float32 `json:"vat_amount,omitempty"`
}

type CheckoutsProcessParams = ProcessCheckout

type CheckoutsProcessResponse struct {
	CheckoutsProcessCheckoutSuccessResponse *CheckoutsProcessCheckoutSuccessResponse
	CheckoutAccepted                        *CheckoutAccepted
}

type CheckoutsUpdateParams = CheckoutUpdateRequest

type ClassicMerchantIdentifiers struct {
	// Classic (serial) merchant ID.
	// Format: int64
	// Deprecated: this operation is deprecated
	ID int64 `json:"id"`
}

type Client struct {
	Checkouts    *CheckoutsClient
	Customers    *CustomersClient
	Members      *MembersClient
	Memberships  *MembershipsClient
	Merchants    *MerchantsClient
	Payouts      *PayoutsClient
	Readers      *ReadersClient
	Receipts     *ReceiptsClient
	Roles        *RolesClient
	Sales        *SalesClient
	Tokens       *TokensClient
	Transactions *TransactionsClient
	// contains filtered or unexported fields
}

type Company struct {
	// The company's primary address.
	// Address documentation: https://developer.sumup.com/tools/glossary/address
	Address *Address `json:"address,omitempty"`
	// Object attributes that are modifiable only by SumUp applications.
	Attributes Attributes `json:"attributes,omitempty"`
	// A list of country-specific company identifiers.
	Identifiers CompanyIdentifiers `json:"identifiers,omitempty"`
	// The category identifying the legal structure of the company or legal entity.
	// Min length: 4
	// Max length: 64
	// Pattern: ^[a-z]{2}\.[a-z_]+$
	// The country SDK documentation for legal types.: https://developer.sumup.com/tools/glossary/merchant#legal-types
	LegalType *LegalType `json:"legal_type,omitempty"`
	// The merchant category code for the account as specified by [ISO18245](https://www.iso.org/standard/33365.html). MCCs
	// are used to classify businesses based on the goods or services they provide.
	// Pattern: ^[0-9]{4}$
	MerchantCategoryCode *string `json:"merchant_category_code,omitempty"`
	// The company's legal name.
	// Min length: 1
	// Max length: 150
	Name *string `json:"name,omitempty"`
	// The company's phone number (used for verification) in [E.164](https://en.wikipedia.org/wiki/E.164) format.
	// Max length: 16
	PhoneNumber *PhoneNumber `json:"phone_number,omitempty"`
	// A trading address is where your suppliers, banks or customers send you correspondence to. Trading address can
	// be different to the company's registered address (`address`).
	// Address documentation: https://developer.sumup.com/tools/glossary/address
	TradingAddress *Address `json:"trading_address,omitempty"`
	// HTTP(S) URL of the company's website.
	// Min length: 1
	// Max length: 255
	Website *string `json:"website,omitempty"`
}

type CompanyIdentifier struct {
	// The unique reference for the company identifier type as defined in the country SDK.
	// Pattern: ^[a-z]{2}\.[a-z_]+$
	Ref string `json:"ref"`
	// The company identifier value.
	// Min length: 1
	// Max length: 100
	Value string `json:"value"`
}

type CompanyIdentifiers []CompanyIdentifier

type CountryCode string

type CreateCheckoutRequest struct {
	// Optional object containing data for transactions from ERP integrators in Greece that comply with the AADE
	// 1155 protocol.
	// When such regulatory/business requirements apply, this object must be provided and contains the data needed
	// to validate the transaction with the AADE signature provider.
	AADE *CreateCheckoutRequestAADE `json:"aade,omitempty"`
	// Optional affiliate metadata associated with the checkout's payment.
	// Provide both `app_id` and `key` when including this object.
	Affiliate *nullable.Field[CreateCheckoutRequestAffiliate] `json:"affiliate,omitempty"`
	// The card type of the card used for the transaction.
	// It is required only for some countries (e.g: Brazil).
	CardType *CreateCheckoutRequestCardType `json:"card_type,omitempty"`
	// Description of the checkout to be shown in the Merchant Sales
	Description *string `json:"description,omitempty"`
	// Number of installments for the transaction.
	// It may vary according to the merchant country.
	// For example, in Brazil, the maximum number of installments is 12.
	//
	// Omit if the merchant country does not support installments.
	// Otherwise, the checkout will be rejected.
	// Min: 1
	Installments *nullable.Field[int] `json:"installments,omitempty"`
	// The payment method type for the transaction. Defaults to `card`.
	//
	// Use `pix` to initiate a Pix QR-code payment flow on the device.
	// Pix is only supported for Brazilian merchants; other merchants will receive a 422 error.
	// Default: card
	PaymentType *CreateCheckoutRequestPaymentType `json:"payment_type,omitempty"`
	// Webhook URL to which the payment result will be sent.
	// It must be a HTTPS url.
	// Format: uri
	ReturnURL *string `json:"return_url,omitempty"`
	// Exactly three distinct tipping rates to be displayed to the cardholder.
	// Each rate is a fraction between 0.01 and 1.00 in increments of 0.01.
	// The rates are sorted in ascending order by the server.
	// Unique items only
	// Min items: 3
	// Max items: 3
	TipRates []float32 `json:"tip_rates,omitempty"`
	// Time in seconds the cardholder has to select a tip rate.
	// If not provided, the default value is 30 seconds.
	//
	// It can only be set if `tip_rates` is provided.
	//
	// **Note**: If the target device is a Solo, it must be in version 3.3.38.0 or higher.
	// Default: 30
	// Min: 30
	// Max: 120
	TipTimeout *int `json:"tip_timeout,omitempty"`
	// Amount structure.
	//
	// The amount is represented as an integer value altogether with the currency and the minor unit.
	//
	// For example, EUR 1.00 is represented as value 100 with minor unit of 2.
	TotalAmount CreateCheckoutRequestTotalAmount `json:"total_amount"`
}

type CreateCheckoutRequestAADE struct {
	// The identifier of the AADE signature provider.
	ProviderID string `json:"provider_id"`
	// The base64 encoded signature of the transaction data.
	Signature string `json:"signature"`
	// The string containing the signed transaction data.
	SignatureData string `json:"signature_data"`
}

type CreateCheckoutRequestAffiliate struct {
	// Integrator application identifier from the [Affiliate Keys](https://developer.sumup.com/affiliate-keys) page.
	//
	// Required when the affiliate object is provided.
	AppID string `json:"app_id"`
	// Integrator-owned transaction reference. Optional.
	// Can be used to retrieve the transaction via the [Transactions API](https://developer.sumup.com/api/transactions/get).
	ForeignTransactionID *string `json:"foreign_transaction_id,omitempty"`
	// Affiliate key generated in the [Affiliate Keys](https://developer.sumup.com/affiliate-keys) page.
	// Required when the affiliate object is provided.
	Key string `json:"key"`
	// Optional key-value metadata associated with the transaction.
	Tags CreateCheckoutRequestAffiliateTags `json:"tags,omitempty"`
}

type CreateCheckoutRequestAffiliateTags map[string]any

type CreateCheckoutRequestCardType string

type CreateCheckoutRequestPaymentType string

type CreateCheckoutRequestTotalAmount struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// The minor units of the currency.
	// It represents the number of decimals of the currency. For the currencies CLP, COP and HUF, the minor unit
	// is 0.
	// Min: 0
	MinorUnit int `json:"minor_unit"`
	// Integer value of the amount.
	// Min: 0
	Value int `json:"value"`
}

type CreateReaderCheckoutError struct {
	Errors CreateReaderCheckoutErrorErrors `json:"errors"`
}

type CreateReaderCheckoutErrorErrors struct {
	// Error message
	Detail *string `json:"detail,omitempty"`
	// Error code
	Type string `json:"type"`
}

type CreateReaderCheckoutResponse struct {
	Data CreateReaderCheckoutResponseData `json:"data"`
}

type CreateReaderCheckoutResponseData struct {
	// The checkout ID is a unique identifier for the checkout.
	CheckoutID *string `json:"checkout_id,omitempty"`
	// Unique identifier for the transaction associated with this checkout.
	// Use this value to match the checkout with payment events and transaction records.
	ClientTransactionID string `json:"client_transaction_id"`
}

type CreateReaderCheckoutUnprocessableEntity struct {
	Errors CreateReaderCheckoutUnprocessableEntityErrors `json:"errors"`
}

type CreateReaderCheckoutUnprocessableEntityErrors map[string]any

type CreateReaderTerminateError struct {
	Errors CreateReaderTerminateErrorErrors `json:"errors"`
}

type CreateReaderTerminateErrorErrors struct {
	// Error message
	Detail *string `json:"detail,omitempty"`
	// Error code
	Type string `json:"type"`
}

type CreateReaderTerminateUnprocessableEntity struct {
	Errors CreateReaderTerminateUnprocessableEntityErrors `json:"errors"`
}

type CreateReaderTerminateUnprocessableEntityErrors map[string]any

type Currency string

type Customer struct {
	// Identifier you supply when creating the customer. Use an ID from your own system and retain it for subsequent customer,
	// checkout, and saved-payment-instrument requests.
	CustomerID string `json:"customer_id"`
	// Personal details for the customer.
	PersonalDetails *PersonalDetails `json:"personal_details,omitempty"`
}

type CustomerValidationError struct {
	// Platform code for the error.
	ErrorCode string `json:"error_code"`
	// Short description of the error.
	ErrorMessage string `json:"error_message"`
	// Unique identifier of this error occurrence.
	Instance string `json:"instance"`
}

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

type CustomersCreate400Response json.RawMessage

type CustomersCreateParams = Customer

type CustomersListPaymentInstrumentsResponse []PaymentInstrumentResponse

type CustomersUpdateParams struct {
	// Personal details for the customer.
	PersonalDetails *PersonalDetails `json:"personal_details,omitempty"`
}

type DetailsError struct {
	// Details of the error.
	Details *string `json:"details,omitempty"`
	// List of violated validation constraints.
	FailedConstraints []DetailsErrorFailedConstraint `json:"failed_constraints,omitempty"`
	// HTTP status code for the error.
	Status *float64 `json:"status,omitempty"`
	// Short title of the error.
	Title *string `json:"title,omitempty"`
}

type DetailsErrorFailedConstraint struct {
	// Human-readable description of the violated constraint.
	Message *string `json:"message,omitempty"`
	// Name of the field that violated the constraint.
	Reference *string `json:"reference,omitempty"`
}

type Device struct {
	// Device model.
	Model *string `json:"model,omitempty"`
	// Device name.
	Name *string `json:"name,omitempty"`
	// Device OS.
	SystemName *string `json:"system_name,omitempty"`
	// Device OS version.
	SystemVersion *string `json:"system_version,omitempty"`
	// Device UUID.
	UUID *string `json:"uuid,omitempty"`
}

type DiscountApplicationMode string

type DiscountClas string

type DiscountLevel string

type DiscountLine struct {
	// A description or reason of the discount.
	// Max length: 250
	Description *string `json:"description,omitempty"`
	// The gross amount of the discount.
	// The value of the amount in minor units of the currency according to the Sale.currency.scale.
	// Format: int64
	// Min: 0
	GrossAmount PositiveAmount `json:"gross_amount"`
	// An id used to associate a discount line with a specific discount.
	// Since we can apply multiple discounts (e.g. 2x 10% whole cart off)
	// we need to be able to identify which discount line belongs to which cart discount.
	// Recommended to use UUID identifiers.
	// Max length: 100
	ID *string `json:"id,omitempty"`
	// Specifies where discount was applied by user (either merchant or consumer):
	// - CART: Applied to the whole cart (calculated and distributed per sale item)
	// - ITEM: Applied to specific sale item
	//
	// *Accepted values:* ["ITEM", "CART"].
	// Min length: 4
	// Max length: 4
	Level DiscountLevel `json:"level"`
	// The net amount of the discount.
	// The value of the amount in minor units of the currency according to the Sale.currency.scale.
	// Format: int64
	// Min: 0
	NetAmount PositiveAmount `json:"net_amount"`
	// The source of discount. Exactly one property must be set.
	Source DiscountSource `json:"source"`
	// The tax amount of the discount.
	// The value of the amount in minor units of the currency according to the Sale.currency.scale.
	// Format: int64
	// Min: 0
	TaxAmount PositiveAmount `json:"tax_amount"`
	// The value type of the discount, either a percentage based or absolute monetary value.
	//
	// It is required that only one of the following is set:
	// - absolute
	// - percentage.
	Value DiscountValue `json:"value"`
}

type DiscountSource struct {
	// Discount created ad-hoc on device during checkout.
	AdHoc *DiscountSourceAdHoc `json:"ad_hoc,omitempty"`
	// Preset discount applied manually on the POS.
	Basic *DiscountSourceBasic `json:"basic,omitempty"`
	// Discount applied manually when entering a coupon code at checkout.
	Coupon *DiscountSourceCoupon `json:"coupon,omitempty"`
	// Discount applied when redeeming a reward from the merchant's loyalty scheme.
	Loyalty *DiscountSourceLoyalty `json:"loyalty,omitempty"`
	// Discount applied automatically when cart is updated based on preset promotions.
	Offer *DiscountSourceOffer `json:"offer,omitempty"`
}

type DiscountSourceAdHoc struct {
	// The description of the ad-hoc discount.
	// Max length: 250
	Description *string `json:"description,omitempty"`
	// The unique identifier of the ad-hoc discount.
	// Format: uuid
	ID *string `json:"id,omitempty"`
	// The name of the ad-hoc discount.
	// Max length: 100
	Name *string `json:"name,omitempty"`
}

type DiscountSourceBasic struct {
	// Method of applying the discount to the items or cart.
	ApplicationMode DiscountApplicationMode `json:"application_mode"`
	// The description of the loyalty discount.
	// Max length: 250
	Description *nullable.Field[string] `json:"description,omitempty"`
	// The unique identifier of the basic discount.
	// Format: uuid
	ID string `json:"id"`
	// The name of the basic discount.
	// Max length: 100
	Name string `json:"name"`
}

type DiscountSourceCoupon struct {
	// Method of applying the discount to the items or cart.
	ApplicationMode DiscountApplicationMode `json:"application_mode"`
	// The coupon code.
	// Max length: 100
	Code string `json:"code"`
	// The description of the coupon discount.
	// Max length: 250
	Description *nullable.Field[string] `json:"description,omitempty"`
	// The method used to target items to discount.
	// Must be populated for ITEM level discounts, and must be null for CART level discounts (CART level targets all
	//
	// items, therefore none of these categories apply).
	DiscountClass *nullable.Field[DiscountClas] `json:"discount_class,omitempty"`
	// The unique identifier of the coupon discount.
	// Format: uuid
	ID string `json:"id"`
	// The name of the coupon discount.
	// Max length: 100
	Name string `json:"name"`
}

type DiscountSourceLoyalty struct {
	// Method of applying the discount to the items or cart.
	ApplicationMode DiscountApplicationMode `json:"application_mode"`
	// The description of the loyalty discount.
	// Max length: 250
	Description *nullable.Field[string] `json:"description,omitempty"`
	// The method used to target items to discount.
	// Must be populated for ITEM level discounts, and must be null for CART level discounts (CART level targets all
	//
	// items, therefore none of these categories apply).
	DiscountClass *nullable.Field[DiscountClas] `json:"discount_class,omitempty"`
	// The unique identifier of the promotion or reward.
	// Format: uuid
	ID string `json:"id"`
	// The type of loyalty discount, either a promotion (e.g. new customer discount) or a reward (free coffee after
	// completing stamp card).
	LoyaltyType DiscountSourceLoyaltyType `json:"loyalty_type"`
	// The name of the loyalty discount.
	// Max length: 100
	Name string `json:"name"`
	// The number of points used for this loyalty discount.
	// Must be a positive integer if the scheme type is POINTS.
	// Must not be populated if the scheme type is STAMPS.
	// Format: int64
	// Min: 1
	Points *nullable.Field[int64] `json:"points,omitempty"`
	// The scheme type of the loyalty program.
	SchemeType DiscountSourceLoyaltySchemeType `json:"scheme_type"`
}

type DiscountSourceLoyaltySchemeType string

type DiscountSourceLoyaltyType string

type DiscountSourceOffer struct {
	// Method of applying the discount to the items or cart.
	ApplicationMode DiscountApplicationMode `json:"application_mode"`
	// The description of the offer discount.
	// Max length: 250
	Description *nullable.Field[string] `json:"description,omitempty"`
	// The method used to target items to discount.
	// Must be populated for ITEM level discounts, and must be null for CART level discounts (CART level targets all
	//
	// items, therefore none of these categories apply).
	DiscountClass *nullable.Field[DiscountClas] `json:"discount_class,omitempty"`
	// The unique identifier of the offer discount.
	// Format: uuid
	ID string `json:"id"`
	// The name of the offer discount.
	// Max length: 100
	Name string `json:"name"`
}

type DiscountValue struct {
	// The absolute value in minor units of the currency according to the Sale.currency.scale.
	// Example: 10000 = 10.00
	// Format: int64
	// Min: 0
	Absolute *PositiveAmount `json:"absolute,omitempty"`
	// The percentage in minor units (1/100000).
	//
	// Examples:
	// - 10% -> 0.10 (decimal) = 10000 (minor units)
	// - 15.5% -> 0.155 (decimal) = 15500 (minor units)
	// - 0.001% -> 0.00001 (decimal) = 1 (minor units)
	// Format: int64
	// Min: 0
	Percentage *int64 `json:"percentage,omitempty"`
}

type ElvCardAccount struct {
	// ELV IBAN.
	IBAN *string `json:"iban,omitempty"`
	// ELV card account number last 4 digits.
	Last4Digits *string `json:"last_4_digits,omitempty"`
	// ELV card sequence number.
	SequenceNo *int `json:"sequence_no,omitempty"`
	// ELV card sort code.
	SortCode *string `json:"sort_code,omitempty"`
}

type EntryMode string

type Error struct {
	// Platform code for the error.
	ErrorCode *string `json:"error_code,omitempty"`
	// Short description of the error.
	Message *string `json:"message,omitempty"`
}

type ErrorExtended struct {
	// Platform code for the error.
	ErrorCode *string `json:"error_code,omitempty"`
	// Short description of the error.
	Message *string `json:"message,omitempty"`
	// Parameter name (with relative location) to which the error applies. Parameters from embedded resources are
	// displayed using dot notation. For example, `card.name` refers to the `name` parameter embedded in the `card`
	// object.
	Param *string `json:"param,omitempty"`
}

type ErrorForbidden struct {
	// Platform code for the error.
	ErrorCode *string `json:"error_code,omitempty"`
	// Short description of the error.
	ErrorMessage *string `json:"error_message,omitempty"`
	// HTTP status code for the error.
	StatusCode *string `json:"status_code,omitempty"`
}

type Event struct {
	// Amount associated with the transaction event, in major units.
	Amount *float32 `json:"amount,omitempty"`
	// Amount deducted from the merchant for the event, in major units.
	DeductedAmount *float32 `json:"deducted_amount,omitempty"`
	// Fee deducted from the merchant for the event, in major units.
	DeductedFeeAmount *float32 `json:"deducted_fee_amount,omitempty"`
	// Fee associated with the transaction event, in major units.
	FeeAmount *float32 `json:"fee_amount,omitempty"`
	// Numeric identifier of a transaction event. Use it as `tx_event_id` when requesting receipt details for a
	// specific event. This is separate from the transaction ID and the transaction history pagination references.
	// Format: int64
	ID *TransactionEventID `json:"id,omitempty"`
	// Consecutive number of the installment associated with the event.
	InstallmentNumber *int `json:"installment_number,omitempty"`
	// Status of the transaction event.
	//
	// Not every value is used for every event type.
	//
	// - `PENDING`: The event has been created but is not final yet. Used for events that are still being processed and
	// whose final outcome is not known yet.
	// - `SCHEDULED`: The event is planned for a future payout cycle but has not been executed yet. This applies to
	// payout events before money is actually sent out.
	// - `RECONCILED`: The underlying payment has been matched with settlement data and is ready to continue through
	// payout processing, but the funds have not been paid out yet. This applies to payout events.
	// - `PAID_OUT`: The payout event has been completed and the funds were included in a merchant payout.
	// - `REFUNDED`: A refund event has been accepted and recorded in the refund flow. This is the status returned for
	// refund events once the transaction amount is being or has been returned to the payer.
	// - `SUCCESSFUL`: The event completed successfully. Use this as the generic terminal success status for event
	// types that do not expose a more specific business outcome such as `PAID_OUT` or `REFUNDED`.
	// - `FAILED`: The event could not be completed. Typical examples are a payout that could not be executed or
	// an event that was rejected during processing.
	Status *TransactionEventStatus `json:"status,omitempty"`
	// The timestamp of when the transaction event occurred.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// Unique identifier of the transaction.
	TransactionID *TransactionID `json:"transaction_id,omitempty"`
	// Financial event associated with a transaction.
	//
	// - `PAYOUT`: Funds from the transaction being prepared for or included in a merchant payout. Check the event
	// status to determine whether they have been paid out.
	// - `REFUND`: Money returned to the payer.
	// - `CHARGE_BACK`: A reversal of the payment following a chargeback.
	// - `PAYOUT_DEDUCTION`: An amount deducted from a merchant payout, for example to cover a refund or chargeback.
	Type *TransactionEventType `json:"type,omitempty"`
}

type EventCallback func(context.Context, EventNotification) error

type EventCallbackError struct{ Err error }

type EventNotification interface {
	EventID() string
	EventType() string
	// contains filtered or unexported methods
}

type EventObject struct {
	// ID identifies the referenced resource.
	ID string `json:"id"`
	// Type is the resource kind, such as member or reader.
	Type string `json:"type"`
	// URL is the absolute API URL for fetching the resource.
	URL string `json:"url"`
}

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

type FeatureV10 struct {
	// The feature name/key.
	// Max length: 100
	Name string `json:"name"`
	// The feature value in canonical string form, to be parsed per `value_type`
	// (e.g. INTEGER -> "3", DECIMAL -> "1.50", DATE -> "2026-07-02",
	// BOOLEAN -> "true"). Carrying it as a string keeps the wire format stable as
	// new feature names and value types are introduced.
	// Max length: 1000
	Value string `json:"value"`
	// The data type of a feature value. The wire `value` is always a string and is parsed
	// according to this type.
	ValueType FeatureValueTypeV10 `json:"value_type"`
}

type FeatureValueTypeV10 string

type FinalPriceAmounts struct {
	// Discounts applied.
	//
	// Important:
	// Discount amounts shouldn't take effect on net and gross amounts.
	//
	// Discount money amounts depend on where discount was applied:
	//  - for item level discount: whole discount money amount is applied
	//  - for cart level discount: only part of the whole amount is applied
	//     (discount money value is split on each line item)
	// Max items: 1000
	Discounts []DiscountLine `json:"discounts,omitempty"`
	// Taxes applied on top of `total_net_amount_final` amount resulting in `total_gross_amount_final` amount.
	// If no discounts are applied, it should be equal to `taxes`.
	// Min items: 1
	// Max items: 1000
	TaxesFinal []PositiveTaxLine `json:"taxes_final"`
	// The final gross amount includes discounts, modifiers, and taxes. If no discounts are applied, it should be
	// equal to total_gross_amount.
	// Format: int64
	// Min: 0
	TotalGrossAmountFinal PositiveAmount `json:"total_gross_amount_final"`
	// The final net amount includes discounts and modifiers. It does NOT include taxes. If no discounts are applied,
	// it should be equal to total_net_amount.
	// Format: int64
	// Min: 0
	TotalNetAmountFinal PositiveAmount `json:"total_net_amount_final"`
}

type FinancialPayout struct {
	// Amount of the payout or deduction in major units.
	Amount float32 `json:"amount"`
	// Three-letter ISO 4217 currency code of the payout.
	Currency string `json:"currency"`
	// Payout date associated with the record, in `YYYY-MM-DD` format.
	// Format: date
	Date datetime.Date `json:"date"`
	// Fee amount associated with the payout record, in major units.
	Fee float32 `json:"fee"`
	// Unique identifier of the payout-related record.
	// Format: int64
	ID int64 `json:"id"`
	// Processor or payout reference associated with the record.
	Reference string `json:"reference"`
	// Merchant-facing outcome of the payout record.
	Status FinancialPayoutStatus `json:"status"`
	// Transaction code of the original sale associated with the payout or deduction.
	TransactionCode string `json:"transaction_code"`
	// High-level payout record category.
	Type FinancialPayoutType `json:"type"`
}

type FinancialPayoutStatus string

type FinancialPayoutType string

type FinancialPayouts []FinancialPayout

type GetReaderCheckoutResponse struct {
	Data GetReaderCheckoutResponseData `json:"data"`
}

type GetReaderCheckoutResponseData struct {
	// Type of the card, or null when no card type was specified.
	CardType nullable.Field[GetReaderCheckoutResponseDataCardType] `json:"card_type"`
	// Unique identifier for the checkout
	// Format: uuid
	CheckoutID string `json:"checkout_id"`
	// Client transaction identifier associated with the checkout
	ClientTransactionID string `json:"client_transaction_id"`
	// Checkout creation timestamp
	CreatedAt time.Time `json:"created_at"`
	// Number of installments for the transaction. Required for some countries.
	Installments nullable.Field[int] `json:"installments"`
	// Reason for the payment failure, or null when no failure reason is available.
	PaymentFailureReason nullable.Field[string] `json:"payment_failure_reason"`
	// Status of the payment, or null when no payment status is available.
	PaymentStatus nullable.Field[string] `json:"payment_status"`
	// Type of the payment. Required for some countries
	PaymentType GetReaderCheckoutResponseDataPaymentType `json:"payment_type"`
	// Reader firmware version
	ReaderFirmwareVersion string `json:"reader_firmware_version"`
	// Device serial number
	ReaderSerialNumber string `json:"reader_serial_number"`
	// Current status of the checkout
	Status GetReaderCheckoutResponseDataStatus `json:"status"`
	// Amount structure.
	//
	// The amount is represented as an integer value altogether with the currency and the minor unit.
	//
	// For example, EUR 1.00 is represented as value 100 with minor unit of 2.
	TotalAmount GetReaderCheckoutResponseDataTotalAmount `json:"total_amount"`
	// Checkout last update timestamp
	UpdatedAt time.Time `json:"updated_at"`
	// Checkout expiration timestamp. After this time, the checkout will be automatically cancelled.
	ValidUntil nullable.Field[time.Time] `json:"valid_until"`
}

type GetReaderCheckoutResponseDataCardType string

type GetReaderCheckoutResponseDataPaymentType string

type GetReaderCheckoutResponseDataStatus string

type GetReaderCheckoutResponseDataTotalAmount struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// The minor units of the currency.
	// It represents the number of decimals of the currency. For the currencies CLP, COP and HUF, the minor unit
	// is 0.
	// Min: 0
	MinorUnit int `json:"minor_unit"`
	// Integer value of the amount.
	// Min: 0
	Value int `json:"value"`
}

type GetReaderSettingsResponse struct {
	Data GetReaderSettingsResponseData `json:"data"`
}

type GetReaderSettingsResponseData struct {
	// Menu lock configuration. Fields may be absent if no value is available.
	MenuLock GetReaderSettingsResponseDataMenuLock `json:"menu_lock"`
}

type GetReaderSettingsResponseDataMenuLock struct {
	// Whether menu lock is enabled.
	Enabled *bool `json:"enabled,omitempty"`
	// Four-digit PIN used to unlock the reader's menu.
	// Format: password
	// Pattern: ^[0-9]{4}$
	Passcode *secret.Secret `json:"passcode,omitempty"`
}

type HorizontalAccuracy float32

type HostedCheckout struct {
	// Whether the checkout should include a SumUp-hosted payment page.
	Enabled bool `json:"enabled"`
}

type Invite struct {
	// Email address of the invited user.
	// Format: email
	Email     string    `json:"email"`
	ExpiresAt time.Time `json:"expires_at"`
}

type ItemReferencesV10 struct {
	// Reference to the backing catalog entity (item variant, deposit, ...),
	// typically a URN such as
	// `urn:sumup:pos:variant:${MERCHANT_CODE}:${ITEM_ID}:${VARIANT_ID}` or
	// `urn:sumup:pos:deposit:${MERCHANT_CODE}:${DEPOSIT_ID}`.
	// Empty for ad-hoc / manual lines. Type-agnostic on purpose: a new item type
	// backed by a catalog entity reuses this field instead of adding its own.
	// Max length: 255
	CatalogReference *string `json:"catalog_reference,omitempty"`
	// The source of the catalog the line originates from.
	// Default: SUMUP
	CatalogSource *ItemReferencesV10CatalogSource `json:"catalog_source,omitempty"`
	// An external reference id connecting this line to another system.
	// Max length: 250
	ExternalID *string `json:"external_id,omitempty"`
	// Stock keeping unit, enriched from the Catalog when available.
	// Max length: 100
	Sku *string `json:"sku,omitempty"`
}

type ItemReferencesV10CatalogSource string

type ItemTypeV10 string

type Lat float32

type LegalType string

type LineItemPriceV10 struct {
	// Discounts applied. Discount amounts do not affect `total_net_amount` /
	// `total_gross_amount`; they are reflected in the `*_final` amounts.
	// Max items: 1000
	Discounts []DiscountLine `json:"discounts,omitempty"`
	// Taxes applied on top of the net amount resulting in the gross amount.
	// Min items: 1
	// Max items: 1000
	Taxes []TaxLine `json:"taxes"`
	// Taxes applied on top of `total_net_amount_final` resulting in `total_gross_amount_final`. Equals `taxes` if
	// no discounts apply.
	// Min items: 1
	// Max items: 1000
	TaxesFinal []TaxLine `json:"taxes_final"`
	// The gross amount (including modifiers if applied). It does NOT include discounts.
	TotalGrossAmount LineItemPriceV10TotalGrossAmount `json:"total_gross_amount"`
	// The final gross amount including discounts, modifiers and taxes. Equals `total_gross_amount` if no discounts apply.
	TotalGrossAmountFinal LineItemPriceV10TotalGrossAmountFinal `json:"total_gross_amount_final"`
	// The net amount (including modifiers if applied). It does NOT include discounts.
	TotalNetAmount LineItemPriceV10TotalNetAmount `json:"total_net_amount"`
	// The final net amount including discounts and modifiers. Equals `total_net_amount` if no discounts apply.
	TotalNetAmountFinal LineItemPriceV10TotalNetAmountFinal `json:"total_net_amount_final"`
	// The price of a single unit. If the tax_mode is GROSS it includes taxes,
	// otherwise no tax is included. It does NOT include discounts.
	// Format: int64
	// Min: 0
	UnitAmount PositiveAmount `json:"unit_amount"`
}

type LineItemPriceV10TotalGrossAmount struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// Amount in minor units (e.g. cents).
	Value int `json:"value"`
}

type LineItemPriceV10TotalGrossAmountFinal struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// Amount in minor units (e.g. cents).
	Value int `json:"value"`
}

type LineItemPriceV10TotalNetAmount struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// Amount in minor units (e.g. cents).
	Value int `json:"value"`
}

type LineItemPriceV10TotalNetAmountFinal struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// Amount in minor units (e.g. cents).
	Value int `json:"value"`
}

type Link struct {
	// URL for accessing the related resource.
	// Format: uri
	Href *string `json:"href,omitempty"`
	// Maximum amount allowed for a refund, in major units.
	MaxAmount *float32 `json:"max_amount,omitempty"`
	// Minimum amount allowed for a refund, in major units.
	MinAmount *float32 `json:"min_amount,omitempty"`
	// Relation of the linked resource to the current resource.
	Rel *string `json:"rel,omitempty"`
	// Media type of the linked resource.
	Type *string `json:"type,omitempty"`
}

type ListPersonsResponseBody struct {
	Items []Person `json:"items"`
}

type Lon float32

type MandatePayload struct {
	// Type of mandate to create for the saved payment instrument.
	Type MandatePayloadType `json:"type"`
	// Browser or client user agent observed when consent was collected.
	UserAgent string `json:"user_agent"`
	// IP address of the payer when the mandate was accepted.
	UserIP *string `json:"user_ip,omitempty"`
}

type MandatePayloadType string

type MandateResponse struct {
	// Short unique identifier for the merchant for which the mandate is valid.
	MerchantCode *string `json:"merchant_code,omitempty"`
	// Current lifecycle status of the mandate.
	Status *MandateResponseStatus `json:"status,omitempty"`
	// Type of mandate stored for the checkout or payment instrument.
	Type *string `json:"type,omitempty"`
}

type MandateResponseStatus string

type Member struct {
	// Object attributes that are modifiable only by SumUp applications.
	Attributes Attributes `json:"attributes,omitempty"`
	// The timestamp of when the member was created.
	CreatedAt time.Time `json:"created_at"`
	// ID of the member.
	ID string `json:"id"`
	// Pending invitation for membership.
	Invite *Invite `json:"invite,omitempty"`
	// Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always
	// submit whole metadata. Maximum of 64 parameters are allowed in the object.
	// Max properties: 64
	Metadata Metadata `json:"metadata,omitempty"`
	// User's permissions.
	// Deprecated: Permissions include only legacy permissions, please use roles instead. Member access is based on
	// roles within a given resource and the permissions these roles grant.
	Permissions []string `json:"permissions"`
	// User's roles.
	Roles []string `json:"roles"`
	// The status of the membership.
	Status MembershipStatus `json:"status"`
	// The timestamp of when the member was last updated.
	UpdatedAt time.Time `json:"updated_at"`
	// Information about the user associated with the membership.
	User *MembershipUser `json:"user,omitempty"`
}

type MemberCreatedEvent struct{ TypedEvent[Member] }

type MemberDeletedEvent struct{ TypedEvent[Member] }

type MemberUpdatedEvent struct{ TypedEvent[Member] }

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

type MembersCreateParams struct {
	// Object attributes that are modifiable only by SumUp applications.
	Attributes Attributes `json:"attributes,omitempty"`
	// Email address of the member to add.
	// Format: email
	// Max length: 256
	Email string `json:"email"`
	// True if the user is managed by the merchant. In this case, we'll created a virtual user with the provided password
	// and nickname.
	IsManagedUser *bool `json:"is_managed_user,omitempty"`
	// Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always
	// submit whole metadata. Maximum of 64 parameters are allowed in the object.
	// Max properties: 64
	Metadata Metadata `json:"metadata,omitempty"`
	// Nickname of the member to add. Only used if `is_managed_user` is true. Used for display purposes only.
	// Max length: 64
	Nickname *string `json:"nickname,omitempty"`
	// Password of the member to add. Only used if `is_managed_user` is true. In the case of service accounts, the
	// password is not used and can not be defined by the caller.
	// Format: password
	// Min length: 8
	Password *secret.Secret `json:"password,omitempty"`
	// List of roles to assign to the new member.
	// Min items: 1
	// Max items: 124
	Roles []string `json:"roles"`
}

type MembersListParams struct {
	// Filter the returned members by email address prefix.
	Email *string
	// Maximum number of members to return.
	Limit *int
	// Offset of the first member to return.
	Offset *int
	// Filter the returned members by role.
	Roles []string
	// Indicates to skip count query.
	Scroll *bool
	// Filter the returned members by the membership status.
	Status *MembershipStatus
	// Search for a member by user id.
	UserID *string
}

type MembersListResponse struct {
	Items      []Member `json:"items"`
	TotalCount *int     `json:"total_count,omitempty"`
}

type MembersUpdateParams struct {
	// Object attributes that are modifiable only by SumUp applications.
	Attributes Attributes `json:"attributes,omitempty"`
	// Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always
	// submit whole metadata. Maximum of 64 parameters are allowed in the object.
	// Max properties: 64
	Metadata Metadata `json:"metadata,omitempty"`
	// Min items: 1
	// Max items: 124
	Roles []string `json:"roles,omitempty"`
	// Allows you to update user data of managed users.
	User *MembersUpdateParamsUser `json:"user,omitempty"`
}

type MembersUpdateParamsUser struct {
	// User's nickname. Used for display purposes only.
	// Max length: 64
	Nickname *string `json:"nickname,omitempty"`
	// Password of the member to add. Only used if `is_managed_user` is true.
	// Format: password
	// Min length: 8
	Password *secret.Secret `json:"password,omitempty"`
}

type Membership struct {
	// Object attributes that are modifiable only by SumUp applications.
	Attributes Attributes `json:"attributes,omitempty"`
	// The timestamp of when the membership was created.
	CreatedAt time.Time `json:"created_at"`
	// ID of the membership.
	ID string `json:"id"`
	// Pending invitation for membership.
	Invite *Invite `json:"invite,omitempty"`
	// Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always
	// submit whole metadata. Maximum of 64 parameters are allowed in the object.
	// Max properties: 64
	Metadata Metadata `json:"metadata,omitempty"`
	// User's permissions.
	// Deprecated: Permissions include only legacy permissions, please use roles instead. Member access is based on
	// their roles within a given resource and the permissions these roles grant.
	Permissions []string `json:"permissions"`
	// Information about the resource the membership is in.
	Resource MembershipResource `json:"resource"`
	// ID of the resource the membership is in.
	ResourceID string `json:"resource_id"`
	// User's roles.
	Roles []string `json:"roles"`
	// The status of the membership.
	Status MembershipStatus `json:"status"`
	// The type of the membership resource.
	// Possible values are:
	// * `merchant` - merchant account(s)
	// * `organization` - organization(s)
	Type ResourceType `json:"type"`
	// The timestamp of when the membership was last updated.
	UpdatedAt time.Time `json:"updated_at"`
}

type MembershipResource struct {
	// Object attributes that are modifiable only by SumUp applications.
	Attributes Attributes `json:"attributes,omitempty"`
	// The timestamp of when the membership resource was created.
	CreatedAt time.Time `json:"created_at"`
	// ID of the resource the membership is in.
	ID string `json:"id"`
	// Logo fo the resource.
	// Format: uri
	// Max length: 256
	Logo *string `json:"logo,omitempty"`
	// Display name of the resource.
	Name string `json:"name"`
	// The type of the membership resource.
	// Possible values are:
	// * `merchant` - merchant account(s)
	// * `organization` - organization(s)
	Type ResourceType `json:"type"`
	// The timestamp of when the membership resource was last updated.
	UpdatedAt time.Time `json:"updated_at"`
}

type MembershipStatus string

type MembershipUser struct {
	// Classic identifiers of the user.
	// Deprecated: this operation is deprecated
	Classic *MembershipUserClassic `json:"classic,omitempty"`
	// Time when the user has been disabled. Applies only to virtual users (`virtual_user: true`).
	DisabledAt *time.Time `json:"disabled_at,omitempty"`
	// End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The
	// RP MUST NOT rely upon this value being unique, for unique identification use ID instead.
	Email string `json:"email"`
	// Identifier for the End-User (also called Subject).
	ID string `json:"id"`
	// True if the user has enabled MFA on login.
	MfaOnLoginEnabled bool `json:"mfa_on_login_enabled"`
	// User's nickname. Used for display purposes only.
	Nickname *string `json:"nickname,omitempty"`
	// URL of the End-User's profile picture. This URL refers to an image file (for example, a PNG, JPEG, or GIF
	// image file), rather than to a Web page containing an image.
	// Format: uri
	Picture *string `json:"picture,omitempty"`
	// True if the user is a service account.
	// Deprecated: Rely on `type` instead.
	ServiceAccountUser bool `json:"service_account_user"`
	// Type of the user account.
	Type UserType `json:"type"`
	// True if the user is a virtual user (operator).
	// Deprecated: Rely on `type` instead.
	VirtualUser bool `json:"virtual_user"`
}

type MembershipUserClassic struct {
	// Min: 0
	// Max: 2.147483647e+09
	UserID int `json:"user_id"`
}

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

type MembershipsListParams struct {
	// Filter memberships by resource kind.
	Kind *ResourceType
	// Maximum number of members to return.
	Limit *int
	// Offset of the first member to return.
	Offset *int
	// Filter memberships by the sandbox status of the resource the membership is in.
	ResourceAttributesSandbox *bool
	// Filter memberships by the ID of the resource the membership is in.
	ResourceID *string
	// Filter memberships by the name of the resource the membership is in.
	ResourceName *string
	// Filter memberships by the parent of the resource the membership is in.
	// Omit both `resource.parent.id` and `resource.parent.type` to skip parent filtering. When filtering by parent,
	// both parameters must be present. To select resources without a parent, set each parameter to an empty value.
	// Otherwise, both parameters must identify a parent.
	ResourceParentID *string
	// Filter memberships by the parent of the resource the membership is in.
	// Omit both `resource.parent.id` and `resource.parent.type` to skip parent filtering. When filtering by parent,
	// both parameters must be present. To select resources without a parent, set each parameter to an empty value.
	// Otherwise, both parameters must identify a parent.
	ResourceParentType *ResourceType
	// Filter memberships by resource kind.
	ResourceType *ResourceType
	// Filter the returned memberships by role.
	Roles []string
	// Filter the returned memberships by the membership status.
	Status *MembershipStatus
}

type MembershipsListResponse struct {
	Items      []Membership `json:"items"`
	TotalCount int          `json:"total_count"`
}

type Merchant struct {
	// A user-facing name of the merchant account for use in dashboards and other user-facing applications. For
	// customer-facing business name see `merchant.business_profile`.
	Alias *string `json:"alias,omitempty"`
	// A user-facing small-format logo for use in dashboards and other user-facing applications. For customer-facing branding
	// see `merchant.business_profile.branding`.
	// Format: uri
	Avatar *string `json:"avatar,omitempty"`
	// Business information about the merchant. This information will be visible to the merchant's customers.
	BusinessProfile *BusinessProfile `json:"business_profile,omitempty"`
	// The business type.
	// * `sole_trader`: The business is run by an self-employed individual.
	// * `company`: The business is run as a company with one or more shareholders
	// * `partnership`: The business is run as a company with two or more shareholders that can be also other legal
	// entities
	// * `non_profit`: The business is run as a nonprofit organization that operates for public or social benefit
	// * `government_entity`: The business is state owned and operated
	BusinessType *string `json:"business_type,omitempty"`
	// Reflects the status of changes submitted through the `PATCH` endpoints for the Merchant or Persons. If some
	// changes have not been applied yet, the status will be `pending`. If all changes have been applied, the status
	// `done`.
	// The status is only returned after write operations or on read endpoints when the `version` query parameter is
	// provided.
	// Read only
	ChangeStatus *ChangeStatus               `json:"change_status,omitempty"`
	Classic      *ClassicMerchantIdentifiers `json:"classic,omitempty"`
	// Information about the company or business. This is legal information that is used for verification.
	// Company documentation: https://developer.sumup.com/tools/glossary/merchant#company
	Company *Company `json:"company,omitempty"`
	// An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
	// country code. This definition users `oneOf` with a two-character string
	// type to allow for support of future countries in client code.
	// Min length: 2
	// Max length: 2
	// Pattern: ^[A-Z]{2}$
	Country CountryCode `json:"country"`
	// The date and time when the resource was created. This is a string as defined in [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).
	// Read only
	CreatedAt time.Time `json:"created_at"`
	// Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) representing the default currency for
	// the account.
	// Read only
	// Min length: 3
	// Max length: 3
	DefaultCurrency string `json:"default_currency"`
	// Merchant's default locale, represented as a BCP47 [RFC5646](https://datatracker.ietf.org/doc/html/rfc5646) language
	// tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1](https://www.iso.org/iso-639-language-code) language code
	// in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1](https://www.iso.org/iso-3166-country-codes.html) country
	// code in uppercase, separated by a dash. For example, en-US or fr-CA.
	// In multilingual countries this is the merchant's preferred locale out of those, that are officially spoken in
	// the country. In a countries with a single official language this will match the official language.
	// Min length: 2
	// Max length: 5
	DefaultLocale string `json:"default_locale"`
	// Short unique identifier for the merchant.
	// Read only
	MerchantCode string `json:"merchant_code"`
	// A set of key-value pairs that you can attach to an object. This can be useful for storing additional information
	// about the object in a structured format.
	//
	// **Warning**: Updating Meta will overwrite the existing data. Make sure to always include the complete JSON
	// object.
	Meta Meta `json:"meta,omitempty"`
	// ID of the organization the merchant belongs to (if any).
	OrganizationID *string `json:"organization_id,omitempty"`
	// True if the merchant is a sandbox for testing.
	Sandbox *bool `json:"sandbox,omitempty"`
	// The date and time when the resource was last updated. This is a string as defined in [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).
	//
	// Read only
	UpdatedAt time.Time `json:"updated_at"`
	// The version of the resource. The version reflects a specific change submitted to the API via one of the `PATCH`
	// endpoints.
	Version *Version `json:"version,omitempty"`
}

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

type Meta map[string]any

type Metadata map[string]any

type ModifierItem = json.RawMessage

type ModifierSet struct {
	// The id of the modifier set that modifier belongs to.
	// Max length: 100
	ID string `json:"id"`
	// The name of the modifier set that the modifier belongs to.
	// Min length: 1
	// Max length: 150
	Name string `json:"name"`
}

type NotFound struct {
	Errors NotFoundErrors `json:"errors"`
}

type NotFoundErrors struct {
	// Fuller message giving context to error
	Detail string `json:"detail"`
}

type Operator struct {
	AccountType OperatorAccountType `json:"account_type"`
	// The timestamp of when the operator was created.
	CreatedAt time.Time `json:"created_at"`
	Disabled  bool      `json:"disabled"`
	// Format: int32
	ID       int32                   `json:"id"`
	Nickname *nullable.Field[string] `json:"nickname,omitempty"`
	// Permissions assigned to an operator or user.
	Permissions Permissions `json:"permissions"`
	// The timestamp of when the operator was last updated.
	UpdatedAt time.Time `json:"updated_at"`
	Username  string    `json:"username"`
}

type OperatorAccountType string

type Ownership struct {
	// The percent of ownership shares held by the Person expressed in percent mille (1/100000). Only Persons with
	// the relationship `owner` can have ownership.
	// Format: int32
	// Min: 25000
	// Max: 100000
	Share int32 `json:"share"`
}

type PaymentInstrumentResponse struct {
	// Indicates whether the payment instrument is active and can be used for payments. To deactivate it, send a
	// `DELETE` request to the resource endpoint.
	// Read only
	// Default: true
	Active *bool `json:"active,omitempty"`
	// Details of the payment card.
	Card *PaymentInstrumentResponseCard `json:"card,omitempty"`
	// The timestamp of when the payment instrument was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// Details of the mandate linked to the saved payment instrument.
	Mandate *MandateResponse `json:"mandate,omitempty"`
	// Token identifying the customer's saved payment card. Pass it as `token`, together with the associated `customer_id`
	// and `payment_type = card`, when processing a checkout with this instrument.
	// Read only
	Token *string `json:"token,omitempty"`
	// Type of the payment instrument.
	Type *PaymentInstrumentResponseType `json:"type,omitempty"`
}

type PaymentInstrumentResponseCard 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 *CardType `json:"type,omitempty"`
}

type PaymentInstrumentResponseType string

type PaymentStatusFilterV10 string

type PaymentType string

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

type PayoutsList400Response []ErrorExtended

type PayoutsListFormat string

type PayoutsListOrder string

type PayoutsListParams struct {
	// End date of the payout period filter, inclusive, in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date`
	// format (`YYYY-MM-DD`). Must be greater than or equal to `start_date`.
	EndDate datetime.Date
	// Response format for the payout list.
	Format *PayoutsListFormat
	// Maximum number of payout records to return.
	Limit *int
	// Sort direction for the returned payouts.
	Order *PayoutsListOrder
	// Start date of the payout period filter, inclusive, in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date`
	// format (`YYYY-MM-DD`).
	StartDate datetime.Date
}

type Permissions struct {
	Admin                      bool `json:"admin"`
	CreateMotoPayments         bool `json:"create_moto_payments"`
	CreateReferral             bool `json:"create_referral"`
	FullTransactionHistoryView bool `json:"full_transaction_history_view"`
	RefundTransactions         bool `json:"refund_transactions"`
}

type Person struct {
	// An address somewhere in the world. The address fields used depend on the country conventions. For example, in
	// Great Britain, `city` is `post_town`. In the United States, the top-level administrative unit used in addresses
	// is `state`, whereas in Chile it's `region`.
	// Whether an address is valid or not depends on whether the locally required fields are present. Fields not
	// supported in a country will be ignored.
	// Address documentation: https://developer.sumup.com/tools/glossary/address
	Address *Address `json:"address,omitempty"`
	// The date of birth of the individual, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format.
	// Format: date
	Birthdate *datetime.Date `json:"birthdate,omitempty"`
	// Reflects the status of changes submitted through the `PATCH` endpoints for the Merchant or Persons. If some
	// changes have not been applied yet, the status will be `pending`. If all changes have been applied, the status
	// `done`.
	// The status is only returned after write operations or on read endpoints when the `version` query parameter is
	// provided.
	// Read only
	ChangeStatus *ChangeStatus `json:"change_status,omitempty"`
	// An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
	// country code. This definition users `oneOf` with a two-character string
	// type to allow for support of future countries in client code.
	// Min length: 2
	// Max length: 2
	// Pattern: ^[A-Z]{2}$
	Citizenship *CountryCode `json:"citizenship,omitempty"`
	// An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code representing the country
	// where the Person resides.
	// Pattern: ^[A-Z]{2}$
	CountryOfResidence *nullable.Field[string] `json:"country_of_residence,omitempty"`
	// The last name(s) of the individual.
	// Min length: 1
	// Max length: 60
	FamilyName *string `json:"family_name,omitempty"`
	// The first name(s) of the individual.
	// Min length: 1
	// Max length: 60
	GivenName *string `json:"given_name,omitempty"`
	// The unique identifier for the Person. This is a [typeid](https://github.com/sumup/typeid).
	// Read only
	ID string `json:"id"`
	// A list of country-specific personal identifiers.
	// Max items: 32
	Identifiers PersonalIdentifiers `json:"identifiers,omitempty"`
	// The Person's nationality. May be an [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country
	// code, but legacy data may not conform to this standard.
	// Pattern: ^[A-Z]{2}$
	Nationality *nullable.Field[string] `json:"nationality,omitempty"`
	Ownership   *Ownership              `json:"ownership,omitempty"`
	// A publicly available phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
	// Max length: 16
	PhoneNumber *PhoneNumber `json:"phone_number,omitempty"`
	// A list of roles the Person has in the Merchant or towards SumUp. A Merchant must have at least one Person with
	// the relationship `representative`.
	// Min items: 1
	// Max items: 1
	Relationships []string `json:"relationships,omitempty"`
	// A corresponding identity user ID for the Person, if they have a user account.
	UserID *string `json:"user_id,omitempty"`
	// The version of the resource. The version reflects a specific change submitted to the API via one of the `PATCH`
	// endpoints.
	Version *Version `json:"version,omitempty"`
}

type PersonalDetails struct {
	// Profile's personal address information.
	Address *AddressLegacy `json:"address,omitempty"`
	// Date of birth of the customer in `YYYY-MM-DD` format, without a time or timezone.
	// Format: date
	BirthDate *datetime.Date `json:"birth_date,omitempty"`
	// Email address of the customer.
	Email *string `json:"email,omitempty"`
	// First name of the customer.
	FirstName *string `json:"first_name,omitempty"`
	// Last name of the customer.
	LastName *string `json:"last_name,omitempty"`
	// Phone number of the customer.
	Phone *string `json:"phone,omitempty"`
	// Identification number used for tax purposes, such as a CPF in Brazil.
	// Max length: 255
	TaxID *string `json:"tax_id,omitempty"`
}

type PersonalIdentifier struct {
	// The unique reference for the personal identifier type.
	// Max length: 32
	Ref string `json:"ref"`
	// The personal identifier value.
	// Max length: 128
	Value string `json:"value"`
}

type PersonalIdentifiers []PersonalIdentifier

type PhoneNumber string

type PositiveAmount int64

type PositivePriceAmounts struct {
	// The gross amount (including modifiers if applied). It does NOT include discounts.
	TotalGrossAmount PositivePriceAmountsTotalGrossAmount `json:"total_gross_amount"`
	// The net amount (including modifiers if applied). It does NOT include discounts.
	TotalNetAmount PositivePriceAmountsTotalNetAmount `json:"total_net_amount"`
	// The price of a single unit.
	// If the tax_mode is GROSS, it includes taxes, otherwise no tax included.
	// It doesn't include discounts.
	// Format: int64
	// Min: 0
	UnitAmount PositiveAmount `json:"unit_amount"`
}

type PositivePriceAmountsTotalGrossAmount struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// Amount in minor units (e.g. cents).
	Value int `json:"value"`
}

type PositivePriceAmountsTotalNetAmount struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// Amount in minor units (e.g. cents).
	Value int `json:"value"`
}

type PositivePriceWithTaxes struct {
	// Taxes applied on top of net amount resulting in gross amount.
	// Min items: 1
	// Max items: 1000
	Taxes []PositiveTaxLine `json:"taxes"`
}

type PositiveTaxLine struct {
	// Gross amount after applying the tax.
	// The value of the amount in minor units of the currency according to the Sale.currency.scale.
	GrossAmount PositiveTaxLineGrossAmount `json:"gross_amount"`
	// Tax ID from the Tax Service (External Id)
	// Max length: 100
	ID string `json:"id"`
	// Tax name, e.g. "MwSt."
	// Max length: 255
	Name *string `json:"name,omitempty"`
	// Net amount before applying the tax.
	// The value of the amount in minor units of the currency according to the Sale.currency.scale.
	NetAmount PositiveTaxLineNetAmount `json:"net_amount"`
	// The tax rate percentage in minor units (1/100000). For example 19000 = 19%.
	// Format: int64
	// Min: 0
	Percentage *TaxRate `json:"percentage,omitempty"`
	// Amount of tax.
	// The value of the amount in minor units of the currency according to the Sale.currency.scale.
	TaxAmount PositiveTaxLineTaxAmount `json:"tax_amount"`
}

type PositiveTaxLineGrossAmount struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// Amount in minor units (e.g. cents).
	Value int `json:"value"`
}

type PositiveTaxLineNetAmount struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// Amount in minor units (e.g. cents).
	Value int `json:"value"`
}

type PositiveTaxLineTaxAmount struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// Amount in minor units (e.g. cents).
	Value int `json:"value"`
}

type PriceAmounts struct {
	// The gross amount (including modifiers if applied). It does NOT include discounts.
	TotalGrossAmount PriceAmountsTotalGrossAmount `json:"total_gross_amount"`
	// The net amount (including modifiers if applied). It does NOT include discounts.
	TotalNetAmount PriceAmountsTotalNetAmount `json:"total_net_amount"`
	// The price of a single unit.
	// If the tax_mode is GROSS, it includes taxes, otherwise no tax included.
	// It doesn't include discounts.
	// Format: int64
	// Min: 0
	UnitAmount PositiveAmount `json:"unit_amount"`
}

type PriceAmountsTotalGrossAmount struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// Amount in minor units (e.g. cents).
	Value int `json:"value"`
}

type PriceAmountsTotalNetAmount struct {
	// Currency ISO 4217 code
	Currency string `json:"currency"`
	// Amount in minor units (e.g. cents).
	Value int `json:"value"`
}

type Problem struct {
	// A human-readable explanation specific to this occurrence of the problem.
	Detail *string `json:"detail,omitempty"`
	// A URI reference that identifies the specific occurrence of the problem.
	// Format: uri
	Instance *string `json:"instance,omitempty"`
	// The HTTP status code generated by the origin server for this occurrence of the problem.
	Status *int `json:"status,omitempty"`
	// A short, human-readable summary of the problem type.
	Title *string `json:"title,omitempty"`
	// A URI reference that identifies the problem type.
	// Format: uri
	Type string `json:"type"`
}

type ProblemV10 struct {
	// A human-readable explanation specific to this occurrence of the problem.
	Detail *string `json:"detail,omitempty"`
	// A URI reference that identifies the specific occurrence of the problem.
	// Format: uri
	Instance *string `json:"instance,omitempty"`
	// The HTTP status code generated by the origin server for this occurrence of the problem.
	Status *int `json:"status,omitempty"`
	// A short, human-readable summary of the problem type.
	Title *string `json:"title,omitempty"`
	// A URI reference that identifies the problem type.
	// Format: uri
	Type string `json:"type"`
}