Documentation
¶
Index ¶
- type AddressLegacy
- type AmountEvent
- type Attributes
- type Currency
- type Date
- type Error
- type ErrorForbidden
- type EventId
- type EventStatus
- type EventType
- type Invite
- type MandateResponse
- type MembershipStatus
- type Meta
- type Metadata
- type PersonalDetails
- type Time
- type TimestampEvent
- type TransactionId
- type TransactionMixinBase
- type TransactionMixinBasePaymentType
- type TransactionMixinBaseStatus
- type TransactionMixinCheckout
- type TransactionMixinCheckoutEntryMode
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddressLegacy ¶ added in v0.3.0
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"`
}
AddressLegacy: Profile's personal address information.
type Attributes ¶
Attributes: Object attributes that are modifiable only by SumUp applications.
type Currency ¶
type Currency string
Currency: Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported currency values are enumerated above.
const ( CurrencyBgn Currency = "BGN" CurrencyBrl Currency = "BRL" CurrencyChf Currency = "CHF" CurrencyClp Currency = "CLP" CurrencyCzk Currency = "CZK" CurrencyDkk Currency = "DKK" CurrencyEur Currency = "EUR" CurrencyGbp Currency = "GBP" CurrencyHrk Currency = "HRK" CurrencyHuf Currency = "HUF" CurrencyNok Currency = "NOK" CurrencyPln Currency = "PLN" CurrencyRon Currency = "RON" CurrencySek Currency = "SEK" CurrencyUsd Currency = "USD" )
type Error ¶
type Error struct {
// Platform code for the error.
ErrorCode *string `json:"error_code,omitempty"`
// Short description of the error.
Message *string `json:"message,omitempty"`
}
Error: Error message structure.
type ErrorForbidden ¶
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"`
}
ErrorForbidden: Error message for forbidden requests.
func (*ErrorForbidden) Error ¶
func (e *ErrorForbidden) Error() string
type EventStatus ¶
type EventStatus string
EventStatus: Status of the transaction event.
const ( EventStatusFailed EventStatus = "FAILED" EventStatusPaidOut EventStatus = "PAID_OUT" EventStatusPending EventStatus = "PENDING" EventStatusRefunded EventStatus = "REFUNDED" EventStatusScheduled EventStatus = "SCHEDULED" EventStatusSuccessful EventStatus = "SUCCESSFUL" )
type Invite ¶
type Invite struct {
// Email address of the invited user.
// Format: email
Email string `json:"email"`
ExpiresAt time.Time `json:"expires_at"`
}
Invite: Pending invitation for membership.
type MandateResponse ¶
type MandateResponse struct {
// Merchant code which has the mandate
MerchantCode *string `json:"merchant_code,omitempty"`
// Mandate status
Status *string `json:"status,omitempty"`
// Indicates the mandate type
Type *string `json:"type,omitempty"`
}
MandateResponse: Created mandate
type MembershipStatus ¶
type MembershipStatus string
MembershipStatus: The status of the membership.
const ( MembershipStatusAccepted MembershipStatus = "accepted" MembershipStatusDisabled MembershipStatus = "disabled" MembershipStatusExpired MembershipStatus = "expired" MembershipStatusPending MembershipStatus = "pending" MembershipStatusUnknown MembershipStatus = "unknown" )
type Meta ¶ added in v0.3.0
Meta: 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.
type Metadata ¶
Metadata: Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata.
type PersonalDetails ¶
type PersonalDetails struct {
// Profile's personal address information.
Address *AddressLegacy `json:"address,omitempty"`
// Date of birth of the customer.
// Format: date
BirthDate *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"`
// An identification number user for tax purposes (e.g. CPF)
// Max length: 255
TaxId *string `json:"tax_id,omitempty"`
}
PersonalDetails: Personal details for the customer.
type TimestampEvent ¶
type TimestampEvent string
TimestampEvent: Date and time of the transaction event.
type TransactionMixinBase ¶
type TransactionMixinBase struct {
// Total amount of the transaction.
Amount *float64 `json:"amount,omitempty"`
// Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported
// currency values are enumerated above.
Currency *Currency `json:"currency,omitempty"`
// Unique ID of the transaction.
Id *string `json:"id,omitempty"`
// Current number of the installment for deferred payments.
// Min: 1
InstallmentsCount *int `json:"installments_count,omitempty"`
// Payment type used for the transaction.
PaymentType *TransactionMixinBasePaymentType `json:"payment_type,omitempty"`
// Current status of the transaction.
Status *TransactionMixinBaseStatus `json:"status,omitempty"`
// Date and time of the creation of the transaction. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code.
Timestamp *time.Time `json:"timestamp,omitempty"`
// Transaction code returned by the acquirer/processing entity after processing the transaction.
TransactionCode *string `json:"transaction_code,omitempty"`
}
TransactionMixinBase: Details of the transaction.
type TransactionMixinBasePaymentType ¶
type TransactionMixinBasePaymentType string
TransactionMixinBasePaymentType: Payment type used for the transaction.
const ( TransactionMixinBasePaymentTypeBoleto TransactionMixinBasePaymentType = "BOLETO" TransactionMixinBasePaymentTypeEcom TransactionMixinBasePaymentType = "ECOM" TransactionMixinBasePaymentTypeRecurring TransactionMixinBasePaymentType = "RECURRING" )
type TransactionMixinBaseStatus ¶
type TransactionMixinBaseStatus string
TransactionMixinBaseStatus: Current status of the transaction.
const ( TransactionMixinBaseStatusCancelled TransactionMixinBaseStatus = "CANCELLED" TransactionMixinBaseStatusFailed TransactionMixinBaseStatus = "FAILED" TransactionMixinBaseStatusPending TransactionMixinBaseStatus = "PENDING" TransactionMixinBaseStatusSuccessful TransactionMixinBaseStatus = "SUCCESSFUL" )
type TransactionMixinCheckout ¶
type TransactionMixinCheckout struct {
// Authorization code for the transaction sent by the payment card issuer or bank. Applicable only to card payments.
AuthCode *string `json:"auth_code,omitempty"`
// Entry mode of the payment details.
EntryMode *TransactionMixinCheckoutEntryMode `json:"entry_mode,omitempty"`
// Internal unique ID of the transaction on the SumUp platform.
InternalId *int `json:"internal_id,omitempty"`
// Unique code of the registered merchant to whom the payment is made.
MerchantCode *string `json:"merchant_code,omitempty"`
// Amount of the tip (out of the total transaction amount).
TipAmount *float64 `json:"tip_amount,omitempty"`
// Amount of the applicable VAT (out of the total transaction amount).
VatAmount *float64 `json:"vat_amount,omitempty"`
}
TransactionMixinCheckout is a schema definition.
type TransactionMixinCheckoutEntryMode ¶
type TransactionMixinCheckoutEntryMode string
TransactionMixinCheckoutEntryMode: Entry mode of the payment details.
const ( TransactionMixinCheckoutEntryModeBoleto TransactionMixinCheckoutEntryMode = "BOLETO" TransactionMixinCheckoutEntryModeCustomerEntry TransactionMixinCheckoutEntryMode = "CUSTOMER_ENTRY" )